Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / LUFA / Drivers / Peripheral / SerialStream.h

diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index bef52ac..3ea1650 100644 (file)
--- 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>
  *
  *  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.
  *
  *  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);
  *  \code
  *      // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode)
  *      SerialStream_Init(9600, false);