forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Oops - light weight ring buffer documentation used \ref instead of \param to document function parameters.

Browse Source
pull/1469/head
Dean Camera 15 years ago
parent b02217d745
commit 5fa0e9c007
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File

8
Projects/Benito/Lib/LightweightRingBuff.h
Unescape View File

@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset * before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function. * by re-initializing them using this function.
* *
* \ref Buffer Pointer to a ring buffer structure to initialize * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/ */
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{ {
@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer. /** Inserts an element into the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to insert into * \param[in,out] Buffer Pointer to a ring buffer structure to insert into
* \ref Data Data element to insert into the buffer * \param[in] Data Data element to insert into the buffer
*/ */
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{ {
@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer. /** Retrieves an element from the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to retrieve from * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
* *
* \return Next data element stored in the buffer * \return Next data element stored in the buffer
*/ */

8
Projects/USBtoSerial/Lib/LightweightRingBuff.h
Unescape View File

@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset * before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function. * by re-initializing them using this function.
* *
* \ref Buffer Pointer to a ring buffer structure to initialize * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/ */
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{ {
@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer. /** Inserts an element into the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to insert into * \param[in,out] Buffer Pointer to a ring buffer structure to insert into
* \ref Data Data element to insert into the buffer * \param[in] Data Data element to insert into the buffer
*/ */
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{ {
@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer. /** Retrieves an element from the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to retrieve from * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
* *
* \return Next data element stored in the buffer * \return Next data element stored in the buffer
*/ */

8
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
Unescape View File

@ -66,7 +66,7 @@
* before any operations are called upon them. Already initialized buffers may be reset * before any operations are called upon them. Already initialized buffers may be reset
* by re-initializing them using this function. * by re-initializing them using this function.
* *
* \ref Buffer Pointer to a ring buffer structure to initialize * \param[out] Buffer Pointer to a ring buffer structure to initialize
*/ */
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{ {
@ -77,8 +77,8 @@
/** Inserts an element into the ring buffer. /** Inserts an element into the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to insert into * \param[in,out] Buffer Pointer to a ring buffer structure to insert into
* \ref Data Data element to insert into the buffer * \param[in] Data Data element to insert into the buffer
*/ */
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{ {
@ -95,7 +95,7 @@
/** Retrieves an element from the ring buffer. /** Retrieves an element from the ring buffer.
* *
* \ref Buffer Pointer to a ring buffer structure to retrieve from * \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
* *
* \return Next data element stored in the buffer * \return Next data element stored in the buffer
*/ */

Write Preview
Loading…
Cancel
Save