RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

core/lib/cib: apply doc best practice

Browse Source 
This patch updates the doxygen comments to follow suggested practice of
using retval.
This commit is contained in:
Joshua DeWeese 2023-08-29 14:48:38 -04:00
parent 03c05f7fe1
commit e2b4e4160a
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/lib/include/cib.h
View File

@ -107,7 +107,8 @@ static inline unsigned int cib_full(const cib_t *cib)
* *
* @param[in,out] cib corresponding *cib* to buffer. * @param[in,out] cib corresponding *cib* to buffer.
* Must not be NULL. * Must not be NULL.
* @return index of next item, -1 if the buffer is empty * @return index of next item
* @retval -1 if the buffer is empty
*/ */
static inline int cib_get(cib_t *__restrict cib) static inline int cib_get(cib_t *__restrict cib)
{ {
@ -153,7 +154,8 @@ static inline int cib_get_unsafe(cib_t *cib)
* *
* @param[in,out] cib corresponding *cib* to buffer. * @param[in,out] cib corresponding *cib* to buffer.
* Must not be NULL. * Must not be NULL.
* @return index of item to put to, -1 if the buffer is full * @return index of item to put to
* @retval -1 if the buffer is full
*/ */
static inline int cib_put(cib_t *__restrict cib) static inline int cib_put(cib_t *__restrict cib)
{ {