X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7ef7f49c9f6b4de962ae32776866bd1d5d59c3b..9e7ffcb014d08d9f541cc8000b34f600b437a78e:/Projects/Magstripe/Lib/CircularBitBuffer.h?ds=sidebyside

diff --git a/Projects/Magstripe/Lib/CircularBitBuffer.h b/Projects/Magstripe/Lib/CircularBitBuffer.h
index 6f1fa1508..05496f62d 100644
--- a/Projects/Magstripe/Lib/CircularBitBuffer.h
+++ b/Projects/Magstripe/Lib/CircularBitBuffer.h
@@ -1,22 +1,22 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2009.
+     Copyright (C) Dean Camera, 2010.
               
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
 
 /*
-  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, and distribute this software
-  and its documentation for any purpose and without fee is hereby
-  granted, provided that the above copyright notice appear in all
-  copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting
-  documentation, and that the name of the author not be used in
-  advertising or publicity pertaining to distribution of the
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -53,7 +53,7 @@
 		#endif
 		
 	/* Type Defines: */
-		/* Type define for a pointer to a bit in a bit buffer. */
+		/** Type define for a pointer to a bit in a bit buffer. */
 		typedef struct
 		{
 			uint8_t* CurrentByte; /**< Pointer to the current byte in the buffer */
@@ -73,23 +73,23 @@
 	/* Function Prototypes: */	
 		/** Initializes or resets a given bit buffer, ready to store new bits.
 		 *  
-		 *  \param Buffer  Bit buffer to initialize
+		 *  \param[in,out] Buffer  Bit buffer to initialize
 		 */
-		void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);
+		void BitBuffer_Init(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1);
 		
 		/** Stores a bit into the next location inside a given bit buffer.
 		 *
-		 *  \param Buffer  Bit buffer to store a bit into
-		 *  \param Bit  Bit to store into the buffer
+		 *  \param[in,out] Buffer  Bit buffer to store a bit into
+		 *  \param[in] Bit  Bit to store into the buffer
 		 */
-		void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);
+		void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer, const bool Bit) ATTR_NON_NULL_PTR_ARG(1);
 		
 		/** Retrieves a bit from the next location inside a given bit buffer.
 		 *
-		 *  \param Buffer  Bit buffer to store a bit into
+		 *  \param[in,out] Buffer  Bit buffer to store a bit into
 		 *
 		 *  \return Next bit from the buffer
 		 */
-		bool BitBuffer_GetNextBit(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);
+		bool BitBuffer_GetNextBit(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1);
 		
 #endif