More minor documentation corrections.

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

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index 3af5d8e..ea2d7c0 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -107,10 +107,10 @@
                {\r
                        uint8_t* In; /**< Current storage location in the circular buffer */\r
                        uint8_t* Out; /**< Current retrieval location in the circular buffer */\r
-                       uint8_t* Start; /** Pointer to the start of the buffer's underlying storage array */\r
-                       uint8_t* End; /** Pointer to the end of the buffer's underlying storage array */\r
-                       uint8_t  Size; /** Size of the buffer's underlying storage array */\r
-                       uint16_t Count; /** Number of bytes currently stored in the buffer */\r
+                       uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array */\r
+                       uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array */\r
+                       uint8_t  Size; /**< Size of the buffer's underlying storage array */\r
+                       uint16_t Count; /**< Number of bytes currently stored in the buffer */\r
                } RingBuff_t;\r
 \r
        /* Inline Functions: */\r
@@ -118,9 +118,9 @@
                 *  before any operations are called upon them. Already initialized buffers may be reset\r
                 *  by re-initializing them using this function.\r
                 *\r
-                *  \param[out] Buffer   Pointer to a ring buffer structure to initialize\r
-                *  \param[out] DataPtr  Pointer to a global array that will hold the data stored into the ring buffer\r
-                *  \param[out] Size     Maximum number of bytes that can be stored in the underlying data array\r
+                *  \param[out] Buffer   Pointer to a ring buffer structure to initialize.\r
+                *  \param[out] DataPtr  Pointer to a global array that will hold the data stored into the ring buffer.\r
+                *  \param[out] Size     Maximum number of bytes that can be stored in the underlying data array.\r
                 */\r
                static inline void RingBuffer_InitBuffer(RingBuff_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)\r
                {\r
@@ -148,7 +148,7 @@
                 *        the returned number should be used only to determine how many successive reads may safely\r
                 *        be performed on the buffer.\r
                 *\r
-                *  \param[in] Buffer  Pointer to a ring buffer structure whose count is to be computed\r
+                *  \param[in] Buffer  Pointer to a ring buffer structure whose count is to be computed.\r
                 */\r
                static inline uint16_t RingBuffer_GetCount(RingBuff_t* const Buffer)\r
                {\r
@@ -166,9 +166,9 @@
                 *  be tested before storing data to the buffer, to ensure that no data is lost due to a\r
                 *  buffer overrun.\r
                 *\r
-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *\r
-                *  \return Boolean true if the buffer contains no free space, false otherwise\r
+                *  \return Boolean true if the buffer contains no free space, false otherwise.\r
                 */\r
                static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)\r
                {\r
@@ -183,9 +183,9 @@
                 *  buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable\r
                 *  to reduce the time spent in atomicity locks.\r
                 *\r
-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *\r
-                *  \return Boolean true if the buffer contains no free space, false otherwise\r
+                *  \return Boolean true if the buffer contains no free space, false otherwise.\r
                 */\r
                static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)\r
                {\r
@@ -198,8 +198,8 @@
                 *        otherwise data corruption may occur. Insertion and removal may occur from different execution\r
                 *        threads.\r
                 *\r
-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into\r
-                *  \param[in]     Data    Data element to insert into the buffer\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
+                *  \param[in]     Data    Data element to insert into the buffer.\r
                 */\r
                static inline void RingBuffer_Insert(RingBuff_t* const Buffer,\r
                                                     const uint8_t Data)\r
@@ -221,9 +221,9 @@
                 *        otherwise data corruption may occur. Insertion and removal may occur from different execution\r
                 *        threads.\r
                 *\r
-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.\r
                 *\r
-                *  \return Next data element stored in the buffer\r
+                *  \return Next data element stored in the buffer.\r
                 */\r
                static inline uint8_t RingBuffer_Remove(RingBuff_t* const Buffer)\r
                {\r
@@ -242,9 +242,9 @@
 \r
                /** Returns the next element stored in the ring buffer, without removing it.\r
                 *\r
-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.\r
                 *\r
-                *  \return Next data element stored in the buffer\r
+                *  \return Next data element stored in the buffer.\r
                 */\r
                static inline uint8_t RingBuffer_Peek(RingBuff_t* const Buffer)\r
                {\r