aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/include/condvars.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-02-06 12:31:09 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-02-06 12:31:09 +0000
commit8e428dbd1a48615c36c8c086dd51079050c9fb1c (patch)
treed1c7168826614acb1925e997915a010f3c4d999b /os/kernel/include/condvars.h
parentf17db1931e95f5ebb42f557b6eead2bf1320db5a (diff)
downloadChibiOS-8e428dbd1a48615c36c8c086dd51079050c9fb1c.tar.gz
ChibiOS-8e428dbd1a48615c36c8c086dd51079050c9fb1c.tar.bz2
ChibiOS-8e428dbd1a48615c36c8c086dd51079050c9fb1c.zip
Kernel headers cleanup.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1568 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/include/condvars.h')
-rw-r--r--os/kernel/include/condvars.h14
1 files changed, 9 insertions, 5 deletions
diff --git a/os/kernel/include/condvars.h b/os/kernel/include/condvars.h
index 7ae7eee9b..be40f7dd3 100644
--- a/os/kernel/include/condvars.h
+++ b/os/kernel/include/condvars.h
@@ -22,8 +22,9 @@
*/
/**
- * @file condvars.h
- * @brief Condition Variables macros and structures.
+ * @file condvars.h
+ * @brief Condition Variables macros and structures.
+ *
* @addtogroup condvars
* @{
*/
@@ -41,10 +42,10 @@
#endif
/**
- * @brief CondVar structure.
+ * @brief CondVar structure.
*/
typedef struct CondVar {
- ThreadsQueue c_queue; /**< CondVar threads queue.*/
+ ThreadsQueue c_queue; /**< @brief CondVar threads queue.*/
} CondVar;
#ifdef __cplusplus
@@ -69,6 +70,8 @@ extern "C" {
* @brief Data part of a static condition variable initializer.
* @details This macro should be used when statically initializing a condition
* variable that is part of a bigger structure.
+ *
+ * @param[in] name the name of the condition variable
*/
#define _CONDVAR_DATA(name) {_THREADSQUEUE_DATA(name.c_queue)}
@@ -76,7 +79,8 @@ extern "C" {
* @brief Static condition variable initializer.
* @details Statically initialized condition variables require no explicit
* initialization using @p chCondInit().
- * @param name the name of the condition variable
+ *
+ * @param[in] name the name of the condition variable
*/
#define CONDVAR_DECL(name) CondVar name = _CONDVAR_DATA(name)