diff --git a/core/include/cib.h b/core/include/cib.h index fc8839bb69e7736926cd071c6b2b3d4d95fe71a7..fb1c161db9754fc11e58a097b80c1bfcdd5c8f10 100644 --- a/core/include/cib.h +++ b/core/include/cib.h @@ -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) {