Rename RingBuffer header functions and typedefs from RingBuff_* to RingBuffer_* so...

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

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index ea2d7c0..ced99f3 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -62,8 +62,8 @@
  *\r
  *  \code\r
  *      // Create the buffer structure and its underlying storage array\r
- *      RingBuff_t Buffer;\r
- *      uint8_t    BufferData[128];\r
+ *      RingBuffer_t Buffer;\r
+ *      uint8_t      BufferData[128];\r
  *\r
  *      // Initialise the buffer with the created storage array\r
  *      RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));\r
@@ -111,7 +111,7 @@
                        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
+               } RingBuffer_t;\r
 \r
        /* Inline Functions: */\r
                /** Initializes a ring buffer ready for use. Buffers must be initialized via this function\r
@@ -122,7 +122,7 @@
                 *  \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
+               static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)\r
                {\r
                        ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
                        {\r
@@ -150,7 +150,7 @@
                 *\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
+               static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer)\r
                {\r
                        uint16_t Count;\r
 \r
@@ -170,7 +170,7 @@
                 *\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
+               static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)\r
                {\r
                        return (RingBuffer_GetCount(Buffer) == Buffer->Size);\r
                }\r
@@ -187,7 +187,7 @@
                 *\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
+               static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)\r
                {\r
                        return (RingBuffer_GetCount(Buffer) == 0);\r
                }\r
@@ -201,7 +201,7 @@
                 *  \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
+               static inline void RingBuffer_Insert(RingBuffer_t* const Buffer,\r
                                                     const uint8_t Data)\r
                {\r
                        *Buffer->In = Data;\r
@@ -225,7 +225,7 @@
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r
-               static inline uint8_t RingBuffer_Remove(RingBuff_t* const Buffer)\r
+               static inline uint8_t RingBuffer_Remove(RingBuffer_t* const Buffer)\r
                {\r
                        uint8_t Data = *Buffer->Out;\r
 \r
@@ -246,7 +246,7 @@
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r
-               static inline uint8_t RingBuffer_Peek(RingBuff_t* const Buffer)\r
+               static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer)\r
                {\r
                        return *Buffer->Out;\r
                }\r