[rtems commit] doxygen: score: adjust doc in corebarrier.h to doxygen guidelines
Sebastian Huber
sebh at rtems.org
Mon May 13 05:52:27 UTC 2019
Module: rtems
Branch: master
Commit: 37ab9081f5f1477a92f66a4823f14fdb21285770
Changeset: http://git.rtems.org/rtems/commit/?id=37ab9081f5f1477a92f66a4823f14fdb21285770
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Fri Apr 5 09:09:19 2019 +0200
doxygen: score: adjust doc in corebarrier.h to doxygen guidelines
Update #3706.
---
cpukit/include/rtems/score/corebarrier.h | 25 +++++++++++++++----------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/cpukit/include/rtems/score/corebarrier.h b/cpukit/include/rtems/score/corebarrier.h
index 73872cb..33798b3 100644
--- a/cpukit/include/rtems/score/corebarrier.h
+++ b/cpukit/include/rtems/score/corebarrier.h
@@ -1,10 +1,12 @@
/**
- * @file
+ * @file
*
- * @brief Constants and Structures Associated with the Barrier Handler
+ * @ingroup RTEMSScoreBarrier
*
- * This include file contains all the constants and structures associated
- * with the Barrier Handler.
+ * @brief Constants and Structures Associated with the Barrier Handler
+ *
+ * This include file contains all the constants and structures associated
+ * with the Barrier Handler.
*/
/*
@@ -26,14 +28,17 @@ extern "C" {
#endif
/**
- * @defgroup RTEMSScoreBarrier Barrier Handler
+ * @defgroup RTEMSScoreBarrier Barrier Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Functionality for Foundation Barrier Services
*
- * @ingroup RTEMSScore
+ * This handler encapsulates functionality which provides the foundation
+ * Barrier services used in all of the APIs supported by RTEMS.
*
- * This handler encapsulates functionality which provides the foundation
- * Barrier services used in all of the APIs supported by RTEMS.
+ * @{
*/
-/**@{*/
/**
* Flavors of barriers.
@@ -81,7 +86,7 @@ typedef struct {
uint32_t number_of_waiting_threads;
} CORE_barrier_Control;
-/**@}*/
+/** @} */
#ifdef __cplusplus
}
More information about the vc
mailing list