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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Tue Apr 16 07:54:11 2019 +0200

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

Update #3706.

---

 cpukit/include/rtems/score/states.h | 23 ++++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

diff --git a/cpukit/include/rtems/score/states.h b/cpukit/include/rtems/score/states.h
index 76fa270..6dcfaaf 100644
--- a/cpukit/include/rtems/score/states.h
+++ b/cpukit/include/rtems/score/states.h
@@ -1,9 +1,11 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Thread Execution State Information
+ * @ingroup RTEMSScoreStates
  *
- *  This include file defines thread execution state information.
+ * @brief Thread Execution State Information
+ *
+ * This include file defines thread execution state information.
  */
 
 /*
@@ -25,14 +27,17 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreStates SuperCore Thread States
+ * @defgroup RTEMSScoreStates SuperCore Thread States
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief SuperCore Thread States
  *
- *  @ingroup RTEMSScore
+ * This handler encapsulates functionality which relates to the management of
+ * the state bitmap associated with each thread.
  *
- *  This handler encapsulates functionality which relates to the management of
- *  the state bitmap associated with each thread.
+ * @{
  */
-/**@{*/
 
 /**
  *  The following type defines the control block used to manage a
@@ -40,7 +45,7 @@ extern "C" {
  */
 typedef uint32_t   States_Control;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }




More information about the vc mailing list