[rtems commit] doxygen: score: adjust doc in threadq.h to doxygen guidelines
Sebastian Huber
sebh at rtems.org
Mon May 13 05:52:28 UTC 2019
Module: rtems
Branch: master
Commit: f1507fb848c7ea14bfdb231098b4265816bd531c
Changeset: http://git.rtems.org/rtems/commit/?id=f1507fb848c7ea14bfdb231098b4265816bd531c
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Tue Apr 16 12:52:26 2019 +0200
doxygen: score: adjust doc in threadq.h to doxygen guidelines
Update #3706.
---
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 a63cc62..522be03 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
}
More information about the vc
mailing list