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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr  4 10:23:18 2019 +0200

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

Update #3706.

---

 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 0c905d5..bf32e59 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
 }



More information about the vc mailing list