diff options
author | Dean Camera <[email protected]> | 2011-01-08 11:47:20 +0000 |
---|---|---|
committer | Dean Camera <[email protected]> | 2011-01-08 11:47:20 +0000 |
commit | 7dc3d3a68f889efeca5af51b22bd043eff8e0926 (patch) | |
tree | 059fabcc52c5b6fae0d49e7a59795261fcc7bdcc /LUFA/Drivers/Misc | |
parent | d1261468875f4772898c4395880735784e651d91 (diff) | |
download | qmk_firmware-7dc3d3a68f889efeca5af51b22bd043eff8e0926.tar.gz qmk_firmware-7dc3d3a68f889efeca5af51b22bd043eff8e0926.zip |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/Misc')
-rw-r--r-- | LUFA/Drivers/Misc/RingBuffer.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/Misc/TerminalCodes.h | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 605f92c119..4b2b9b22c5 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -170,7 +170,7 @@ *
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
- * \return Boolean true if the buffer contains no free space, false otherwise.
+ * \return Boolean \c true if the buffer contains no free space, false otherwise.
*/
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
{
@@ -187,7 +187,7 @@ *
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
- * \return Boolean true if the buffer contains no free space, false otherwise.
+ * \return Boolean \c true if the buffer contains no free space, false otherwise.
*/
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
{
diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 192e4af036..6b9d3fbb8f 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -45,7 +45,7 @@ * \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 + * \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). * @@ -71,7 +71,7 @@ #if !defined(DISABLE_TERMINAL_CODES) /** Creates an ANSI escape sequence with the specified payload. * - * \param[in] EscapeSeq Payload to encode as an ANSI escape sequence, a ESC_* mask. + * \param[in] EscapeSeq Payload to encode as an ANSI escape sequence, a \c ESC_* mask. */ #define ANSI_ESCAPE_SEQUENCE(EscapeSeq) "\33[" EscapeSeq #else |