aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Misc
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-06-01 21:55:31 +0200
committerDean Camera <dean@fourwalledcubicle.com>2013-06-01 21:55:31 +0200
commit7941245122dc547952e573b2c5e8fd7bc657f257 (patch)
tree80ce02a74b7714d26089f750c6223c102abc9158 /LUFA/Drivers/Misc
parent16037433a2caf0c93b811b774a9ea5fd1324514e (diff)
downloadlufa-7941245122dc547952e573b2c5e8fd7bc657f257.tar.gz
lufa-7941245122dc547952e573b2c5e8fd7bc657f257.tar.bz2
lufa-7941245122dc547952e573b2c5e8fd7bc657f257.zip
Ensure core library documentation sections use unique IDs.
Diffstat (limited to 'LUFA/Drivers/Misc')
-rw-r--r--LUFA/Drivers/Misc/RingBuffer.h16
-rw-r--r--LUFA/Drivers/Misc/TerminalCodes.h6
2 files changed, 11 insertions, 11 deletions
diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index 0ab3e33ab..bc6cfe885 100644
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -44,11 +44,11 @@
* \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h
* \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
*
- * \section Sec_Dependencies Module Source Dependencies
+ * \section Sec_RingBuff_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
* - None
*
- * \section Sec_ModDescription Module Description
+ * \section Sec_RingBuff_ModDescription Module Description
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
* different sizes to suit different needs.
*
@@ -57,7 +57,7 @@
* or deletions) must not overlap. If there is possibility of two or more of the same kind of
* operating occurring at the same point in time, atomic (mutex) locking should be used.
*
- * \section Sec_ExampleUsage Example Usage
+ * \section Sec_RingBuff_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
@@ -65,23 +65,23 @@
* // Create the buffer structure and its underlying storage array
* RingBuffer_t Buffer;
* uint8_t BufferData[128];
- *
+ *
* // Initialize the buffer with the created storage array
* RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));
- *
+ *
* // Insert some data into the buffer
* RingBuffer_Insert(Buffer, 'H');
* RingBuffer_Insert(Buffer, 'E');
* RingBuffer_Insert(Buffer, 'L');
* RingBuffer_Insert(Buffer, 'L');
* RingBuffer_Insert(Buffer, 'O');
- *
+ *
* // Cache the number of stored bytes in the buffer
* uint16_t BufferCount = RingBuffer_GetCount(&Buffer);
- *
+ *
* // Printer stored data length
* printf("Buffer Length: %d, Buffer Data: \r\n", BufferCount);
- *
+ *
* // Print contents of the buffer one character at a time
* while (BufferCount--)
* putc(RingBuffer_Remove(&Buffer));
diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index 696c17d5e..55cd5e0ab 100644
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -39,18 +39,18 @@
* \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
* \brief ANSI terminal special escape code macros.
*
- * \section Sec_Dependencies Module Source Dependencies
+ * \section Sec_Terminal_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
* - None
*
- * \section Sec_ModDescription Module Description
+ * \section Sec_Terminal_ModDescription Module Description
* Escape code macros for ANSI compliant text terminals.
*
* \note If desired, the macro \c 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).
*
- * \section Sec_ExampleUsage Example Usage
+ * \section Sec_Terminal_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*