[PATCH 72/98] doxygen: score: adjust doc in stack.h to doxygen guidelines
Sebastian Huber
sebastian.huber at embedded-brains.de
Tue May 7 05:40:17 UTC 2019
From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
---
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 3f80a1e12c..1158f3472e 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
}
--
2.16.4
More information about the devel
mailing list