[PATCH 04/98] doxygen: score: adjust doc in chain.h to doxygen guidelines

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


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

---
 cpukit/include/rtems/score/chain.h | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/cpukit/include/rtems/score/chain.h b/cpukit/include/rtems/score/chain.h
index 0c905d5016..bf32e5926f 100644
--- a/cpukit/include/rtems/score/chain.h
+++ b/cpukit/include/rtems/score/chain.h
@@ -25,17 +25,20 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreChain Chain Handler
+ * @defgroup RTEMSScoreChain Chain Handler
  *
- *  @ingroup RTEMSScore
+ * @ingroup RTEMSScore
  *
- *  The Chain Handler is used to manage sets of entities.  This handler
- *  provides two data structures.  The Chain Node data structure is included
- *  as the first part of every data structure that will be placed on
- *  a chain.  The second data structure is Chain Control which is used
- *  to manage a set of Chain Nodes.
+ * @brief Provides Data Structures Chain Node and Chain Control
+ *
+ * The Chain Handler is used to manage sets of entities.  This handler
+ * provides two data structures.  The Chain Node data structure is included
+ * as the first part of every data structure that will be placed on
+ * a chain.  The second data structure is Chain Control which is used
+ * to manage a set of Chain Nodes.
+ *
+ * @{
  */
-/**@{*/
 
 /**
  *  @typedef Chain_Node
@@ -92,7 +95,7 @@ typedef union {
   } Tail;
 } Chain_Control;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }
-- 
2.16.4



More information about the devel mailing list