aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Misc/TerminalCodes.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-12-26 14:55:26 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-12-26 14:55:26 +0000
commita8b66f318dda3cc18dfcedaa3af3d01ab68b82e8 (patch)
tree3f3e7d02bfebc4bab83983e96e84f5e04d044d02 /LUFA/Drivers/Misc/TerminalCodes.h
parent2073b96d82433607bd287e3b6529fd0d3cc428cd (diff)
downloadlufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.gz
lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.bz2
lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.zip
Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
Diffstat (limited to 'LUFA/Drivers/Misc/TerminalCodes.h')
-rw-r--r--LUFA/Drivers/Misc/TerminalCodes.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index e1cba1674..0b82613d3 100644
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -42,16 +42,22 @@
* The following files must be built with any user project that uses this module:
* - None
*
- * \section Module Description
+ * \section Sec_ModDescription 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 codes then equate to empty strings).
*
- * <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
- * printf("Some String, " ESC_BOLD_ON " Some bold string");
+ * printf("Normal String, "
+ * ESC_BOLD_ON "Bold String, "
+ * ESC_UNDERLINE_ON "Bold and Underlined String"
+ * ESC_RESET ESC_FG_BLUE ESC_BG_YELLOW "Normal Blue-on-Yellow String");
* \endcode
*
* @{