Add to the existing CDC Class Driver's CreateStream() function documentation to explicitly state that the created streams are bidirectional.

This commit is contained in:
Dean Camera 2009-11-29 05:19:41 +00:00
parent 958d28d05d
commit 414b92e812
4 changed files with 7 additions and 9 deletions

View file

@ -215,7 +215,8 @@
uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
* functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
* functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
* stream is bidirectional and can be used for both input and output functions.
*
* \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
* to the given CDC interface.