diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
| commit | d38fa49cb6cb3804c9bb17601688a62ba466b535 (patch) | |
| tree | 15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Drivers/Peripheral/SerialStream.h | |
| parent | 6380d057f8911f5d09bdffff4220aa9602df49e2 (diff) | |
| download | lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.bz2 lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip | |
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Drivers/Peripheral/SerialStream.h')
| -rw-r--r-- | LUFA/Drivers/Peripheral/SerialStream.h | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h index 394fd081d..275313589 100644 --- a/LUFA/Drivers/Peripheral/SerialStream.h +++ b/LUFA/Drivers/Peripheral/SerialStream.h @@ -35,11 +35,17 @@ * USART.
**/
-/** \ingroup Group_SubsystemDrivers
+/** \ingroup Group_PeripheralDrivers
* @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.h
*
- * Functions, macros, variables, enums and types related to the setup of a serial stream, so that standard printf and other
- * C stream functions can be used on the serial port.
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/Peripheral/SerialStream.c
+ *
+ * \section Module Description
+ * Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
+ * regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the
+ * USART.
*
* @{
*/
|