mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
cib: doc fix
This commit is contained in:
parent
7cc2a9105f
commit
2adc0eae75
@ -15,7 +15,7 @@
|
||||
* @details This structure provides an organizational interface
|
||||
* and combined with an memory array forms a circular buffer.
|
||||
*
|
||||
* @author unknown, propably Kaspar Schleiser <kaspar@schleiser.de>
|
||||
* @author unknown, probably Kaspar Schleiser <kaspar@schleiser.de>
|
||||
*/
|
||||
|
||||
#ifndef CIB_H
|
||||
@ -42,7 +42,7 @@ typedef struct {
|
||||
#define CIB_INIT(SIZE) { 0, 0, (SIZE) - 1 }
|
||||
|
||||
/**
|
||||
* @brief Initialize cib_t to 0 and set size.
|
||||
* @brief Initialize @p cib to 0 and set buffer size to @p size.
|
||||
*
|
||||
* @param[out] cib Buffer to initialize.
|
||||
* Must not be NULL.
|
||||
@ -63,7 +63,7 @@ static inline void cib_init(cib_t *__restrict cib, unsigned int size)
|
||||
*
|
||||
* @param[in] cib the cib_t to check.
|
||||
* Must not be NULL.
|
||||
* @return How often cib_get() can be called before the CIB is empty.
|
||||
* @return How often cib_get() can be called before @p cib is empty.
|
||||
*/
|
||||
static inline unsigned int cib_avail(cib_t *__restrict cib)
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user