From bae98eb8d8e752aa084a2438aa99d5f72e3f1247 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Thu, 22 Jan 2009 15:37:29 +0000
Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@666
 35acf78f-673a-0410-8e92-d51de3d6d3f4

---
 src/include/condvars.h   |  2 +-
 src/include/events.h     |  4 ++--
 src/include/lists.h      | 13 +++++++++----
 src/include/mutexes.h    |  2 +-
 src/include/queues.h     |  5 +++--
 src/include/scheduler.h  |  3 ++-
 src/include/semaphores.h |  2 +-
 src/include/serial.h     |  4 ++--
 src/include/threads.h    |  3 ++-
 src/include/vt.h         |  4 ++--
 src/lib/ch.hpp           | 16 ++++++++--------
 src/lib/evtimer.h        |  2 +-
 src/templates/chcore.h   | 17 +++++++++--------
 13 files changed, 43 insertions(+), 34 deletions(-)

(limited to 'src')

diff --git a/src/include/condvars.h b/src/include/condvars.h
index be23bf6d1..ef9a37791 100644
--- a/src/include/condvars.h
+++ b/src/include/condvars.h
@@ -32,7 +32,7 @@
 #if defined(CH_USE_CONDVARS) && defined(CH_USE_MUTEXES)
 
 /**
- * CondVar structure.
+ * @brief CondVar structure.
  */
 typedef struct CondVar {
   ThreadsQueue          c_queue;
diff --git a/src/include/events.h b/src/include/events.h
index 1f2e2a15a..4ae3d3540 100644
--- a/src/include/events.h
+++ b/src/include/events.h
@@ -33,7 +33,7 @@
 typedef struct EventListener EventListener;
 
 /**
- * Event Listener structure.
+ * @brief Event Listener structure.
  */
 struct EventListener {
   /** Next Event Listener registered on the Event Source.*/
@@ -45,7 +45,7 @@ struct EventListener {
 };
 
 /**
- * Event Source structure.
+ * @brief Event Source structure.
  */
 typedef struct EventSource {
   /** First Event Listener registered on the Event Source.*/
diff --git a/src/include/lists.h b/src/include/lists.h
index 10b5d7823..339c6741c 100644
--- a/src/include/lists.h
+++ b/src/include/lists.h
@@ -32,7 +32,7 @@ typedef struct Thread Thread;
 #define notempty(p)     ((p)->p_next != (Thread *)(p))
 
 /**
- * Generic threads queue header and element.
+ * @brief Generic threads queue header and element.
  * @extends ThreadsList
  */
 typedef struct {
@@ -43,17 +43,22 @@ typedef struct {
 } ThreadsQueue;
 
 /**
- * Generic threads single link list, it works like a stack.
+ * @brief Generic threads single link list.
+ * @details This list behaves like a stack.
  */
 typedef struct {
   /** Last pushed @p Thread on the stack list, or @p ThreadList when empty. */
   Thread                *p_next;
 } ThreadsList;
 
-/*
- * Threads Lists functions and macros.
+/**
+ * Queue initialization.
  */
 #define queue_init(tqp) ((tqp)->p_next = (tqp)->p_prev = (Thread *)(tqp));
+
+/**
+ * List initialization.
+ */
 #define list_init(tlp)  ((tlp)->p_next = (Thread *)(tlp))
 
 #ifndef CH_OPTIMIZE_SPEED
diff --git a/src/include/mutexes.h b/src/include/mutexes.h
index 247b5ad7c..2040d64eb 100644
--- a/src/include/mutexes.h
+++ b/src/include/mutexes.h
@@ -28,7 +28,7 @@
 #ifdef CH_USE_MUTEXES
 
 /**
- * Mutex structure.
+ * @brief Mutex structure.
  */
 typedef struct Mutex {
   /** Queue of the threads sleeping on this Mutex.*/
diff --git a/src/include/queues.h b/src/include/queues.h
index 90456f4d1..a11a5a73f 100644
--- a/src/include/queues.h
+++ b/src/include/queues.h
@@ -41,7 +41,8 @@ typedef void (*qnotify_t)(void);
 
 #ifdef CH_USE_QUEUES
 /**
- * I/O queue structure, it is used by both Input and Output Queues,
+ * @brief I/O queue structure.
+ * @details This structure is used by both Input and Output Queues,
  * the difference is on how the semaphore is initialized.
  */
 typedef struct {
@@ -116,7 +117,7 @@ extern "C" {
 
 #ifdef CH_USE_QUEUES_HALFDUPLEX
 /**
- * Half duplex queue structure.
+ * @brief Half duplex queue structure.
  */
 typedef struct {
   /** Pointer to the queue buffer. */
diff --git a/src/include/scheduler.h b/src/include/scheduler.h
index 7d2f95beb..0549f217c 100644
--- a/src/include/scheduler.h
+++ b/src/include/scheduler.h
@@ -53,7 +53,8 @@
 #define firstprio(rlp)  ((rlp)->p_next->p_prio)
 
 /**
- * Ready list header.
+ * @brief Ready list header.
+ *
  * @extends ThreadsQueue
  */
 typedef struct {
diff --git a/src/include/semaphores.h b/src/include/semaphores.h
index ba75d8ba7..0f1a493d4 100644
--- a/src/include/semaphores.h
+++ b/src/include/semaphores.h
@@ -28,7 +28,7 @@
 #ifdef CH_USE_SEMAPHORES
 
 /**
- * Semaphore structure.
+ * @brief Semaphore structure.
  */
 typedef struct Semaphore {
   /** Queue of the threads sleeping on this Semaphore.*/
diff --git a/src/include/serial.h b/src/include/serial.h
index 0dfd02c56..ffe030e4b 100644
--- a/src/include/serial.h
+++ b/src/include/serial.h
@@ -46,7 +46,7 @@ typedef uint16_t dflags_t;
 #ifdef CH_USE_SERIAL_FULLDUPLEX
 
 /**
- * Full Duplex Serial Driver main structure.
+ * @brief Full Duplex Serial Driver main structure.
  */
 typedef struct {
 
@@ -111,7 +111,7 @@ extern "C" {
 #ifdef CH_USE_SERIAL_HALFDUPLEX
 
 /**
- * Full Duplex Serial Driver main structure.
+ * @brief Full Duplex Serial Driver main structure.
  */
 typedef struct {
 
diff --git a/src/include/threads.h b/src/include/threads.h
index 5ca7dd0ce..5877f49da 100644
--- a/src/include/threads.h
+++ b/src/include/threads.h
@@ -26,7 +26,8 @@
 #define _THREADS_H_
 
 /**
- * Structure representing a thread.
+ * @brief Structure representing a thread.
+ *
  * @extends ThreadsQueue
  * @note Not all the listed fields are always needed, by switching off some
  *       not needed ChibiOS/RT subsystems it is possible to save RAM space by
diff --git a/src/include/vt.h b/src/include/vt.h
index 04af725c9..89ad275e4 100644
--- a/src/include/vt.h
+++ b/src/include/vt.h
@@ -48,7 +48,7 @@ typedef void (*vtfunc_t)(void *);
 typedef struct VirtualTimer VirtualTimer;
 
 /**
- * Virtual Timer descriptor structure.
+ * @brief Virtual Timer descriptor structure.
  * @extends DeltaList
  */
 struct VirtualTimer {
@@ -66,7 +66,7 @@ struct VirtualTimer {
 };
 
 /**
- * Delta List header.
+ * @brief Virtual timers list header.
  * @note The delta list is implemented as a double link bidirectional list in
  *       order to make the unlink time constant, the reset of a virtual timer
  *       is often used in the code.
diff --git a/src/lib/ch.hpp b/src/lib/ch.hpp
index 4a052ed39..377eed6d6 100644
--- a/src/lib/ch.hpp
+++ b/src/lib/ch.hpp
@@ -281,12 +281,12 @@ namespace chibios_rt {
 
 #ifdef CH_USE_SEMAPHORES
   /**
-   * @brief Class encapsulating a @p Semaphore.
+   * @brief Class encapsulating a semaphore.
    */
   class Semaphore {
   public:
     /**
-     * @brief Embedded @p Semaphore structure.
+     * @brief Embedded @p ::Semaphore structure.
      */
     struct ::Semaphore sem;
 
@@ -349,12 +349,12 @@ namespace chibios_rt {
 
 #ifdef CH_USE_MUTEXES
   /**
-   * @brief Class encapsulating a @p Mutex.
+   * @brief Class encapsulating a mutex.
    */
   class Mutex {
   public:
     /**
-     * @brief Embedded @p Mutex structure.
+     * @brief Embedded @p ::Mutex structure.
      */
     struct ::Mutex mutex;
 
@@ -398,12 +398,12 @@ namespace chibios_rt {
 
 #ifdef CH_USE_CONDVARS
   /**
-   * @brief Class encapsulating a @p CondVar.
+   * @brief Class encapsulating a conditional variable.
    */
   class CondVar {
   public:
     /**
-     * @brief Embedded @p CondVar structure.
+     * @brief Embedded @p ::CondVar structure.
      */
     struct ::CondVar condvar;
 
@@ -453,12 +453,12 @@ namespace chibios_rt {
 
 #ifdef CH_USE_EVENTS
   /**
-   * @brief Class encapsulating an @p EventSource.
+   * @brief Class encapsulating an event source.
    */
   class Event {
   public:
     /**
-     * @brief Embedded @p EventSource structure.
+     * @brief Embedded @p ::EventSource structure.
      */
     struct ::EventSource event;
 
diff --git a/src/lib/evtimer.h b/src/lib/evtimer.h
index 5a148e4db..cb3e4c44c 100644
--- a/src/lib/evtimer.h
+++ b/src/lib/evtimer.h
@@ -26,7 +26,7 @@
 #define _EVTIMER_H_
 
 /**
- * Event timer structure.
+ * @brief Event timer structure.
  */
 typedef struct {
   VirtualTimer  et_vt;
diff --git a/src/templates/chcore.h b/src/templates/chcore.h
index 97f3f05e7..8c7ed97ef 100644
--- a/src/templates/chcore.h
+++ b/src/templates/chcore.h
@@ -38,24 +38,25 @@
 typedef uint8_t stkalign_t;
 
 /**
- * Interrupt saved context.
- * This structure represents the stack frame saved during a preemption-capable
- * interrupt handler.
+ * @brief Interrupt saved context.
+ * @details This structure represents the stack frame saved during a
+ * preemption-capable interrupt handler.
  */
 struct extctx {
 };
 
 /**
- * System saved context.
- * This structure represents the inner stack frame during a context switching.
+ * @brief System saved context.
+ * @details This structure represents the inner stack frame during a context
+ * switching.
  */
 struct intctx {
 };
 
 /**
- * Platform dependent part of the @p Thread structure.
- * This structure usually contains just the saved stack pointer defined as a
- * pointer to a @p intctx structure.
+ * @brief Platform dependent part of the @p Thread structure.
+ * @details This structure usually contains just the saved stack pointer
+ * defined as a pointer to a @p intctx structure.
  */
 struct context {
   struct intctx *sp;
-- 
cgit v1.2.3