[PATCH 81/98] doxygen: score: adjust doc in threadq.h to doxygen guidelines

Sebastian Huber sebastian.huber at embedded-brains.de
Tue May 7 05:40:26 UTC 2019


From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

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

diff --git a/cpukit/include/rtems/score/threadq.h b/cpukit/include/rtems/score/threadq.h
index a63cc62151..522be03970 100644
--- a/cpukit/include/rtems/score/threadq.h
+++ b/cpukit/include/rtems/score/threadq.h
@@ -1,10 +1,12 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Constants and Structures Needed to Declare a Thread Queue
+ * @ingroup RTEMSScoreThreadQueue
  *
- *  This include file contains all the constants and structures
- *  needed to declare a thread queue.
+ * @brief Constants and Structures Needed to Declare a Thread Queue
+ *
+ * This include file contains all the constants and structures
+ * needed to declare a thread queue.
  */
 
 /*
@@ -36,15 +38,18 @@ struct Per_CPU_Control;
 struct Scheduler_Node;
 
 /**
- *  @defgroup RTEMSScoreThreadQueue Thread Queue Handler
+ * @defgroup RTEMSScoreThreadQueue Thread Queue Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Thread Queue Handler
  *
- *  @ingroup RTEMSScore
+ * This handler provides the capability to have threads block in
+ * ordered sets. The sets may be ordered using the FIFO or priority
+ * discipline.
  *
- *  This handler provides the capability to have threads block in
- *  ordered sets. The sets may be ordered using the FIFO or priority
- *  discipline.
+ * @{
  */
-/**@{*/
 
 typedef struct _Thread_Control Thread_Control;
 
@@ -578,7 +583,7 @@ typedef struct {
   Thread_queue_Queue Queue;
 } Thread_queue_Control;
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }
-- 
2.16.4




More information about the devel mailing list