X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/2073b96d82433607bd287e3b6529fd0d3cc428cd..ef44b8c036daf4806a369dfdcd5adf72cf85b824:/LUFA/Drivers/Peripheral/SerialStream.h

diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index bef52ac9e..cf376e98a 100644
--- a/LUFA/Drivers/Peripheral/SerialStream.h
+++ b/LUFA/Drivers/Peripheral/SerialStream.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -32,8 +32,8 @@
  *  \brief Standard avr-libc character stream driver for 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
+ *  regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (\c printf,
+ *  \c puts, etc.) to work with the
  *  USART.
  */
 
@@ -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.
+ *  regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (\c printf,
+ *  \c puts, etc.) to work with the USART. Upon configuration, this will redirect the \c stdin standard input
+ *  and \c stdout output streams to the USART.
+ *
+ *  \section Sec_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
  *
- *  <b>Example Usage:</b>
  *  \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)
 			}