aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Misc
diff options
context:
space:
mode:
Diffstat (limited to 'LUFA/Drivers/Misc')
-rw-r--r--LUFA/Drivers/Misc/RingBuffer.h7
-rw-r--r--LUFA/Drivers/Misc/TerminalCodes.h12
2 files changed, 14 insertions, 5 deletions
diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index af6a69f83..3af5d8e44 100644
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -47,7 +47,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
- * \section Module Description
+ * \section Sec_ModDescription Module Description
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
* different sizes to suit different needs.
*
@@ -56,7 +56,10 @@
* or deletions) must not overlap. If there is possibility of two or more of the same kind of
* operating occuring at the same point in time, atomic (mutex) locking should be used.
*
- * <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
* // Create the buffer structure and its underlying storage array
* RingBuff_t Buffer;
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
*
* @{