[rtems commit] doxygen: score: adjust doc in coresem.h to doxygen guidelines

Sebastian Huber sebh at rtems.org
Mon May 13 05:52:27 UTC 2019


Module:    rtems
Branch:    master
Commit:    eab90bff1dde147be688079ae34f5090583c48ba
Changeset: http://git.rtems.org/rtems/commit/?id=eab90bff1dde147be688079ae34f5090583c48ba

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Mon Apr  8 10:29:29 2019 +0200

doxygen: score: adjust doc in coresem.h to doxygen guidelines

Update #3706.

---

 cpukit/include/rtems/score/coresem.h | 28 ++++++++++++++++------------
 1 file changed, 16 insertions(+), 12 deletions(-)

diff --git a/cpukit/include/rtems/score/coresem.h b/cpukit/include/rtems/score/coresem.h
index b44daf5..e1f22dc 100644
--- a/cpukit/include/rtems/score/coresem.h
+++ b/cpukit/include/rtems/score/coresem.h
@@ -1,12 +1,14 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Data Associated with the Counting Semaphore Handler
+ * @ingroup RTEMSScoreSemaphore
  *
- *  This include file contains all the constants and structures associated
- *  with the Counting Semaphore Handler.  A counting semaphore is the
- *  standard Dijkstra binary semaphore used to provide synchronization
- *  and mutual exclusion capabilities.
+ * @brief Data Associated with the Counting Semaphore Handler
+ *
+ * This include file contains all the constants and structures associated
+ * with the Counting Semaphore Handler.  A counting semaphore is the
+ * standard Dijkstra binary semaphore used to provide synchronization
+ * and mutual exclusion capabilities.
  */
 
 /*
@@ -28,14 +30,16 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreSemaphore Semaphore Handler
+ * @defgroup RTEMSScoreSemaphore Semaphore Handler
+ *
+ * @ingroup RTEMSScore
  *
- *  @ingroup RTEMSScore
+ * @brief Semaphore Handler
  *
- *  This handler encapsulates functionality which provides the foundation
- *  Semaphore services used in all of the APIs supported by RTEMS.
+ * This handler encapsulates functionality which provides the foundation
+ * Semaphore services used in all of the APIs supported by RTEMS.
  */
-/**@{*/
+/** @{ */
 
 /**
  *  The following defines the control block used to manage each
@@ -51,7 +55,7 @@ typedef struct {
   uint32_t                    count;
 }   CORE_semaphore_Control;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }



More information about the vc mailing list