Minor documentation improvements.

[pub/lufa.git] / LUFA / Drivers / Misc / RingBuffer.h

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index 07ae0cd..0ab3e33 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -204,7 +204,7 @@
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *

-                *  \return Boolean \c true if the buffer contains no free space, false otherwise.
+                *  \return Boolean \c true if the buffer contains no free space, \c false otherwise.

                 */
                static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
                static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
                 */
                static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
                static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)


@@ -218,7 +218,7 @@
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *
                 *
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
                 *

-                *  \return Boolean \c true if the buffer contains no free space, false otherwise.
+                *  \return Boolean \c true if the buffer contains no free space, \c false otherwise.

                 */
                static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
                static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
                 */
                static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
                static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)