X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7ef7f49c9f6b4de962ae32776866bd1d5d59c3b..24f730fce3f2022762011d795c3feada5ef874b3:/Projects/Magstripe/Lib/CircularBitBuffer.h?ds=inline diff --git a/Projects/Magstripe/Lib/CircularBitBuffer.h b/Projects/Magstripe/Lib/CircularBitBuffer.h index 6f1fa1508..c5d1c1a20 100644 --- a/Projects/Magstripe/Lib/CircularBitBuffer.h +++ b/Projects/Magstripe/Lib/CircularBitBuffer.h @@ -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