Ooops - TeensyHID bootloader makefile should use a 16MHz FCPU, not 8MHz.

[pub/USBasp.git] / Projects / Magstripe / Lib / CircularBitBuffer.h

diff --git a/Projects/Magstripe/Lib/CircularBitBuffer.h b/Projects/Magstripe/Lib/CircularBitBuffer.h
index 6f1fa15..c5d1c1a 100644 (file)
--- a/Projects/Magstripe/Lib/CircularBitBuffer.h
+++ b/Projects/Magstripe/Lib/CircularBitBuffer.h
@@ -53,7 +53,7 @@
                #endif\r
                \r
        /* Type Defines: */\r
                #endif\r
                \r
        /* Type Defines: */\r

-               /* Type define for a pointer to a bit in a bit buffer. */\r
+               /** Type define for a pointer to a bit in a bit buffer. */\r

                typedef struct\r
                {\r
                        uint8_t* CurrentByte; /**< Pointer to the current byte in the buffer */\r
                typedef struct\r
                {\r
                        uint8_t* CurrentByte; /**< Pointer to the current byte in the buffer */\r


@@ -73,23 +73,23 @@
        /* Function Prototypes: */      \r
                /** Initializes or resets a given bit buffer, ready to store new bits.\r
                 *  \r
        /* Function Prototypes: */      \r
                /** Initializes or resets a given bit buffer, ready to store new bits.\r
                 *  \r

-                *  \param Buffer  Bit buffer to initialize\r
+                *  \param[in,out] Buffer  Bit buffer to initialize\r

                 */\r
                 */\r

-               void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               void BitBuffer_Init(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1);\r

                \r
                /** Stores a bit into the next location inside a given bit buffer.\r
                 *\r
                \r
                /** Stores a bit into the next location inside a given bit buffer.\r
                 *\r

-                *  \param Buffer  Bit buffer to store a bit into\r
-                *  \param Bit  Bit to store into the buffer\r
+                *  \param[in,out] Buffer  Bit buffer to store a bit into\r
+                *  \param[in] Bit  Bit to store into the buffer\r

                 */\r
                 */\r

-               void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);\r
+               void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer, const bool Bit) ATTR_NON_NULL_PTR_ARG(1);\r

                \r
                /** Retrieves a bit from the next location inside a given bit buffer.\r
                 *\r
                \r
                /** Retrieves a bit from the next location inside a given bit buffer.\r
                 *\r

-                *  \param Buffer  Bit buffer to store a bit into\r
+                *  \param[in,out] Buffer  Bit buffer to store a bit into\r

                 *\r
                 *  \return Next bit from the buffer\r
                 */\r
                 *\r
                 *  \return Next bit from the buffer\r
                 */\r

-               bool BitBuffer_GetNextBit(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               bool BitBuffer_GetNextBit(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1);\r

                \r
 #endif\r
                \r
 #endif\r