From e2b4e4160a2ef87db8d84328ef62d19d00c29e22 Mon Sep 17 00:00:00 2001 From: Joshua DeWeese Date: Tue, 29 Aug 2023 14:48:38 -0400 Subject: [PATCH] core/lib/cib: apply doc best practice This patch updates the doxygen comments to follow suggested practice of using retval. --- core/lib/include/cib.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/core/lib/include/cib.h b/core/lib/include/cib.h index 5e304e5510..c807b6049b 100644 --- a/core/lib/include/cib.h +++ b/core/lib/include/cib.h @@ -107,7 +107,8 @@ static inline unsigned int cib_full(const cib_t *cib) * * @param[in,out] cib corresponding *cib* to buffer. * 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) { @@ -153,7 +154,8 @@ static inline int cib_get_unsafe(cib_t *cib) * * @param[in,out] cib corresponding *cib* to buffer. * 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) {