From 2adc0eae759cd909c1deaa579cfbd1aa0369d8d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cenk=20G=C3=BCndo=C4=9Fan?= <cnkgndgn@gmail.com>
Date: Sat, 9 Apr 2016 13:01:32 +0200
Subject: [PATCH] cib: doc fix
---
core/include/cib.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/include/cib.h b/core/include/cib.h
index fc8839bb69..fb1c161db9 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)
{
--
GitLab