aboutsummaryrefslogtreecommitdiff
path: root/LUFA/Drivers/Peripheral/SerialStream.h
diff options
context:
space:
mode:
authorDean Camera <[email protected]>2010-12-26 14:55:26 +0000
committerDean Camera <[email protected]>2010-12-26 14:55:26 +0000
commita8b66f318dda3cc18dfcedaa3af3d01ab68b82e8 (patch)
tree3f3e7d02bfebc4bab83983e96e84f5e04d044d02 /LUFA/Drivers/Peripheral/SerialStream.h
parent2073b96d82433607bd287e3b6529fd0d3cc428cd (diff)
downloadqmk_firmware-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.gz
qmk_firmware-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.zip
Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
Diffstat (limited to 'LUFA/Drivers/Peripheral/SerialStream.h')
-rw-r--r--LUFA/Drivers/Peripheral/SerialStream.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index bef52ac9ef..3ea1650662 100644
--- a/LUFA/Drivers/Peripheral/SerialStream.h
+++ b/LUFA/Drivers/Peripheral/SerialStream.h
@@ -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);