Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
This commit is contained in:
parent
2073b96d82
commit
a8b66f318d
109 changed files with 357 additions and 318 deletions
|
@ -44,13 +44,16 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - LUFA/Drivers/Peripheral/SerialStream.c <i>(Makefile source module name: LUFA_SRC_SERIALSTREAM)</i>
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
|
||||
* regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,
|
||||
* puts, etc.) to work with the USART. Upon configuration, this will redirect the standard input and output
|
||||
* streams to the USART.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode)
|
||||
* SerialStream_Init(9600, false);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue