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/Misc | |
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/Misc')
-rw-r--r-- | LUFA/Drivers/Misc/TerminalCodes.h | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 1206ade26..b81a8d674 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -33,6 +33,18 @@ * ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing
* strings to modify their display on a compatible terminal application.
*
+ */
+
+/** \ingroup Group_MiscDrivers
+ * @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
+ *
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Module Description
+ * Escape code macros for ANSI compliant text terminals.
+ *
* \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC
* compiler via the -D switch to disable the terminal codes without modifying the source, for use with non
* compatible terminals (any terminal code then equate to empty strings).
@@ -41,12 +53,6 @@ * \code
* printf("Some String, " ESC_BOLD_ON " Some bold string");
* \endcode
- */
-
-/** \ingroup Group_MiscDrivers
- * @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
- *
- * Escape code macros for ANSI compliant text terminals.
*
* @{
*/
|