riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5275 from cgundogan/pr/cib/doc_fix

Browse Source 
cib: doc fix
This commit is contained in:
Cenk Gündoğan 2016-04-11 07:39:30 +02:00
commit aa15ec59dc
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/include/cib.h
View File

@ -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)
{