[PATCH 13/98] doxygen: score: adjust doc in coremutex.h to doxygen guidelines

Sebastian Huber sebastian.huber at embedded-brains.de
Tue May 7 05:39:18 UTC 2019


From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

---
 cpukit/include/rtems/score/coremutex.h | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/cpukit/include/rtems/score/coremutex.h b/cpukit/include/rtems/score/coremutex.h
index 447eafb913..7d3d831c1f 100644
--- a/cpukit/include/rtems/score/coremutex.h
+++ b/cpukit/include/rtems/score/coremutex.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSScoreMutex
+ *
  * @brief CORE Mutex API
  *
  * This include file contains all the constants and structures associated with
@@ -34,14 +36,17 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreMutex Mutex Handler
+ * @defgroup RTEMSScoreMutex Mutex Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Mutex Handler
  *
- *  @ingroup RTEMSScore
+ * This handler encapsulates functionality which provides the foundation
+ * Mutex services used in all of the APIs supported by RTEMS.
  *
- *  This handler encapsulates functionality which provides the foundation
- *  Mutex services used in all of the APIs supported by RTEMS.
+ * @{
  */
-/**@{*/
 
 /**
  *  @brief Control block used to manage each mutex.
@@ -94,7 +99,7 @@ typedef struct {
 #endif
 } CORE_ceiling_mutex_Control;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }
-- 
2.16.4



More information about the devel mailing list