Rename RingBuffer header functions and typedefs from RingBuff_* to RingBuffer_* so...

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

diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index bef52ac..577d675 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>
  *
- *  \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);
@@ -94,6 +97,13 @@
        #endif
 
        /* Public Interface - May be used in end-application: */
+               /* External Variables: */
+                       /** Named stream for the USART, once \ref SerialStream_Init() has been called. This may be used with the
+                        *  file based stream functions (fprintf, fscanf, etc.) that require a handle to the stream rather than
+                        *  using the stdin and stdout named streams.
+                        */
+                       extern FILE USARTStream;
+
                /* Inline Functions: */
                        /** Initialises the serial stream (and regular USART driver) so that both the stream and regular
                         *  USART driver functions can be used. Must be called before any stream or regular USART functions.
@@ -118,13 +128,6 @@
                                Serial_ShutDown();
                        }
 
-               /* External Variables: */
-                       /** Named stream for the USART, once \ref SerialStream_Init() has been called. This may be used with the
-                        *  file based stream functions (fprintf, fscanf, etc.) that require a handle to the stream rather than
-                        *  using the stdin and stdout named streams.
-                        */
-                       extern FILE USARTStream;
-
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }