[rtems commit] doxygen: score: adjust doc in coremsg.h to doxygen guidelines
Sebastian Huber
sebh at rtems.org
Mon May 13 05:52:27 UTC 2019
Module: rtems
Branch: master
Commit: 4bd8757626b825baf53ae99388ec1a175fbabffe
Changeset: http://git.rtems.org/rtems/commit/?id=4bd8757626b825baf53ae99388ec1a175fbabffe
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Fri Apr 5 09:13:16 2019 +0200
doxygen: score: adjust doc in coremsg.h to doxygen guidelines
Update #3706.
---
cpukit/include/rtems/score/coremsg.h | 25 +++++++++++++++----------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/cpukit/include/rtems/score/coremsg.h b/cpukit/include/rtems/score/coremsg.h
index e2dd14b..cabf08b 100644
--- a/cpukit/include/rtems/score/coremsg.h
+++ b/cpukit/include/rtems/score/coremsg.h
@@ -1,10 +1,12 @@
/**
- * @file
+ * @file
*
- * @brief Constants and Structures Associated with the Message Queue Handler.
+ * @ingroup RTEMSScoreMessageQueue
*
- * This include file contains all the constants and structures associated
- * with the Message queue Handler.
+ * @brief Constants and Structures Associated with the Message Queue Handler.
+ *
+ * This include file contains all the constants and structures associated
+ * with the Message queue Handler.
*/
/*
@@ -29,14 +31,17 @@ extern "C" {
#endif
/**
- * @defgroup RTEMSScoreMessageQueue Message Queue Handler
+ * @defgroup RTEMSScoreMessageQueue Message Queue Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Message Queue Handler
*
- * @ingroup RTEMSScore
+ * This handler encapsulates functionality which provides the foundation
+ * Message Queue services used in all of the APIs supported by RTEMS.
*
- * This handler encapsulates functionality which provides the foundation
- * Message Queue services used in all of the APIs supported by RTEMS.
+ * @{
*/
-/**@{*/
/**
* This macro is defined when an API is enabled that requires that the
@@ -171,7 +176,7 @@ struct CORE_message_queue_Control {
Chain_Control Inactive_messages;
};
-/**@}*/
+/** @} */
#ifdef __cplusplus
}
More information about the vc
mailing list