X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/272d446d3242f1d449447a91cdc1f7516ffe964f..29ba88cffd4198b02e8ca04c31aed2c175c5502e:/LUFA/Drivers/Misc/RingBuffer.h

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index 9319f11e9..1a825ac23 100644
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -29,7 +29,7 @@
 */
 
 /** \file
- *  \brief Lightweight ring buffer, for fast insertion/deletion.
+ *  \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
  *
  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
  *  different sizes to suit different needs.
@@ -41,7 +41,8 @@
  */
  
 /** \ingroup Group_MiscDrivers
- *  @defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h
+ *  \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
  *  The following files must be built with any user project that uses this module:
@@ -93,10 +94,6 @@
 #define __RING_BUFFER_H__
 
 	/* Includes: */
-		#include <util/atomic.h>
-		#include <stdint.h>
-		#include <stdbool.h>
-
 		#include "../../Common/Common.h"
 
 	/* Type Defines: */
@@ -107,12 +104,12 @@
 		 */
 		typedef struct
 		{
-			uint8_t* In; /**< Current storage location in the circular buffer */
-			uint8_t* Out; /**< Current retrieval location in the circular buffer */
-			uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array */
-			uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array */
-			uint8_t  Size; /**< Size of the buffer's underlying storage array */
-			uint16_t Count; /**< Number of bytes currently stored in the buffer */
+			uint8_t* In; /**< Current storage location in the circular buffer. */
+			uint8_t* Out; /**< Current retrieval location in the circular buffer. */
+			uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array. */
+			uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array. */
+			uint8_t  Size; /**< Size of the buffer's underlying storage array. */
+			uint16_t Count; /**< Number of bytes currently stored in the buffer. */
 		} RingBuffer_t;
 
 	/* Inline Functions: */