From f17db1931e95f5ebb42f557b6eead2bf1320db5a Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Sat, 6 Feb 2010 10:55:53 +0000
Subject: Reformatted doxygen tags into the kernel sources to make them more
 readable.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1567 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/kernel/include/ch.h       | 17 ++++++++++-------
 os/kernel/include/channels.h |  5 +++--
 os/kernel/include/events.h   | 22 ++++++++++++----------
 os/kernel/include/heap.h     |  9 +++++----
 4 files changed, 30 insertions(+), 23 deletions(-)

(limited to 'os/kernel/include')

diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h
index 109040262..0607e2d52 100644
--- a/os/kernel/include/ch.h
+++ b/os/kernel/include/ch.h
@@ -18,8 +18,11 @@
 */
 
 /**
- * @file ch.h
- * @brief ChibiOS/RT main include file, it includes everything else.
+ * @file    ch.h
+ * @brief   ChibiOS/RT main include file.
+ * @details This header includes all the required kernel headers so it is the
+ *          only kernel header you usually want to include in your application.
+ *
  * @addtogroup kernel_info
  * @{
  */
@@ -28,27 +31,27 @@
 #define _CH_H_
 
 /**
- * ChibiOS/RT identification macro.
+ * @brief   ChibiOS/RT identification macro.
  */
 #define _CHIBIOS_RT_
 
 /**
- * Kernel version string.
+ * @brief   Kernel version string.
  */
 #define CH_KERNEL_VERSION       "1.5.1unstable"
 
 /**
- * Kernel version major number.
+ * @brief   Kernel version major number.
  */
 #define CH_KERNEL_MAJOR         1
 
 /**
- * Kernel version minor number.
+ * @brief   Kernel version minor number.
  */
 #define CH_KERNEL_MINOR         5
 
 /**
- * Kernel version patch number.
+ * @brief   Kernel version patch number.
  */
 #define CH_KERNEL_PATCH         1
 
diff --git a/os/kernel/include/channels.h b/os/kernel/include/channels.h
index c822e99e8..2aa8cb0f6 100644
--- a/os/kernel/include/channels.h
+++ b/os/kernel/include/channels.h
@@ -18,8 +18,9 @@
 */
 
 /**
- * @file channels.h
- * @brief I/O channels.
+ * @file    channels.h
+ * @brief   I/O channels.
+ *
  * @addtogroup io_channels
  * @{
  */
diff --git a/os/kernel/include/events.h b/os/kernel/include/events.h
index de49d1aea..0cc4032b8 100644
--- a/os/kernel/include/events.h
+++ b/os/kernel/include/events.h
@@ -109,7 +109,9 @@ typedef void (*evhandler_t)(eventid_t);
 #ifdef __cplusplus
 extern "C" {
 #endif
-  void chEvtRegisterMask(EventSource *esp, EventListener *elp, eventmask_t emask);
+  void chEvtRegisterMask(EventSource *esp,
+                         EventListener *elp,
+                         eventmask_t mask);
   void chEvtUnregister(EventSource *esp, EventListener *elp);
   eventmask_t chEvtClear(eventmask_t mask);
   eventmask_t chEvtPend(eventmask_t mask);
@@ -119,23 +121,23 @@ extern "C" {
   void chEvtBroadcastI(EventSource *esp);
   void chEvtDispatch(const evhandler_t handlers[], eventmask_t mask);
 #if CH_OPTIMIZE_SPEED || !CH_USE_EVENTS_TIMEOUT
-  eventmask_t chEvtWaitOne(eventmask_t ewmask);
-  eventmask_t chEvtWaitAny(eventmask_t ewmask);
-  eventmask_t chEvtWaitAll(eventmask_t ewmask);
+  eventmask_t chEvtWaitOne(eventmask_t mask);
+  eventmask_t chEvtWaitAny(eventmask_t mask);
+  eventmask_t chEvtWaitAll(eventmask_t mask);
 #endif
 #if CH_USE_EVENTS_TIMEOUT
-  eventmask_t chEvtWaitOneTimeout(eventmask_t ewmask, systime_t time);
-  eventmask_t chEvtWaitAnyTimeout(eventmask_t ewmask, systime_t time);
-  eventmask_t chEvtWaitAllTimeout(eventmask_t ewmask, systime_t time);
+  eventmask_t chEvtWaitOneTimeout(eventmask_t mask, systime_t time);
+  eventmask_t chEvtWaitAnyTimeout(eventmask_t mask, systime_t time);
+  eventmask_t chEvtWaitAllTimeout(eventmask_t mask, systime_t time);
 #endif
 #ifdef __cplusplus
 }
 #endif
 
 #if !CH_OPTIMIZE_SPEED && CH_USE_EVENTS_TIMEOUT
-#define chEvtWaitOne(ewmask) chEvtWaitOneTimeout(ewmask, TIME_INFINITE)
-#define chEvtWaitAny(ewmask) chEvtWaitAnyTimeout(ewmask, TIME_INFINITE)
-#define chEvtWaitAll(ewmask) chEvtWaitAllTimeout(ewmask, TIME_INFINITE)
+#define chEvtWaitOne(ewmask) chEvtWaitOneTimeout(emask, TIME_INFINITE)
+#define chEvtWaitAny(ewmask) chEvtWaitAnyTimeout(emask, TIME_INFINITE)
+#define chEvtWaitAll(ewmask) chEvtWaitAllTimeout(emask, TIME_INFINITE)
 #endif
 
 #endif /* CH_USE_EVENTS */
diff --git a/os/kernel/include/heap.h b/os/kernel/include/heap.h
index be95a41c5..b628e3b9f 100644
--- a/os/kernel/include/heap.h
+++ b/os/kernel/include/heap.h
@@ -18,8 +18,9 @@
 */
 
 /**
- * @file heap.h
- * @brief Heaps macros and structures.
+ * @file    heap.h
+ * @brief   Heaps macros and structures.
+ *
  * @addtogroup heaps
  * @{
  */
@@ -43,7 +44,7 @@
 typedef struct memory_heap MemoryHeap;
 
 /**
- * @brief Memory heap block header.
+ * @brief   Memory heap block header.
  */
 struct heap_header {
   union {
@@ -54,7 +55,7 @@ struct heap_header {
 };
 
 /**
- * @brief Structure describing a memory heap.
+ * @brief   Structure describing a memory heap.
  */
 struct memory_heap {
   memgetfunc_t          h_provider; /**< @brief Memory blocks provider for
-- 
cgit v1.2.3