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

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


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

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

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

Update #3706.

---

 cpukit/include/rtems/score/stack.h | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

diff --git a/cpukit/include/rtems/score/stack.h b/cpukit/include/rtems/score/stack.h
index 3f80a1e..1158f34 100644
--- a/cpukit/include/rtems/score/stack.h
+++ b/cpukit/include/rtems/score/stack.h
@@ -1,11 +1,13 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Information About the Thread Stack Handler
+ * @ingroup RTEMSScoreStack
  *
- *  This include file contains all information about the thread
- *  Stack Handler.  This Handler provides mechanisms which can be used to
- *  initialize and utilize stacks.
+ * @brief Information About the Thread Stack Handler
+ *
+ * This include file contains all information about the thread
+ * Stack Handler.  This Handler provides mechanisms which can be used to
+ * initialize and utilize stacks.
  */
 
 /*
@@ -27,14 +29,17 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup RTEMSScoreStack Stack Handler
+ * @defgroup RTEMSScoreStack Stack Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Stack Handler
  *
- *  @ingroup RTEMSScore
+ * This handler encapsulates functionality which is used in the management
+ * of thread stacks.
  *
- *  This handler encapsulates functionality which is used in the management
- *  of thread stacks.
+ * @{
  */
-/**@{*/
 
 /**
  *  The following constant defines the minimum stack size which every
@@ -59,7 +64,7 @@ typedef struct {
  */
 extern uint32_t rtems_minimum_stack_size;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }



More information about the vc mailing list