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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Fri Apr  5 09:03:31 2019 +0200

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

Update #3706.

---

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

diff --git a/cpukit/include/rtems/score/context.h b/cpukit/include/rtems/score/context.h
index 1b23d96..a01e296 100644
--- a/cpukit/include/rtems/score/context.h
+++ b/cpukit/include/rtems/score/context.h
@@ -1,9 +1,11 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Information About Each Thread's Context
+ * @ingroup RTEMSScoreContext
  *
- *  This include file contains all information about each thread's context.
+ * @brief Information About Each Thread's Context
+ *
+ * This include file contains all information about each thread's context.
  */
 
 /*
@@ -19,17 +21,20 @@
 #define _RTEMS_SCORE_CONTEXT_H
 
 /**
- *  @defgroup RTEMSScoreContext Context Handler
+ * @defgroup RTEMSScoreContext Context Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Functionality for Abstraction of Thread Context Management
  *
- *  @ingroup RTEMSScore
+ * This handler encapsulates functionality which abstracts thread context
+ * management in a portable manner.
  *
- *  This handler encapsulates functionality which abstracts thread context
- *  management in a portable manner.
+ * The context switch needed variable is contained in the per cpu
+ * data structure.
  *
- *  The context switch needed variable is contained in the per cpu
- *  data structure.
+ * @{
  */
-/**@{*/
 
 #ifdef __cplusplus
 extern "C" {
@@ -157,7 +162,7 @@ extern "C" {
 }
 #endif
 
-/**@}*/
+/** @} */
 
 #endif
 /* end of include file */




More information about the vc mailing list