[rtems commit] doxygen: score: adjust doc in coremutex.h to doxygen guidelines
Sebastian Huber
sebh at rtems.org
Mon May 13 05:52:27 UTC 2019
Module: rtems
Branch: master
Commit: d369903b0ec6655a17c7fc445718faf84edffc83
Changeset: http://git.rtems.org/rtems/commit/?id=d369903b0ec6655a17c7fc445718faf84edffc83
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Mon Apr 8 09:11:24 2019 +0200
doxygen: score: adjust doc in coremutex.h to doxygen guidelines
Update #3706.
---
cpukit/include/rtems/score/coremutex.h | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/cpukit/include/rtems/score/coremutex.h b/cpukit/include/rtems/score/coremutex.h
index 447eafb..7d3d831 100644
--- a/cpukit/include/rtems/score/coremutex.h
+++ b/cpukit/include/rtems/score/coremutex.h
@@ -1,6 +1,8 @@
/**
* @file
*
+ * @ingroup RTEMSScoreMutex
+ *
* @brief CORE Mutex API
*
* This include file contains all the constants and structures associated with
@@ -34,14 +36,17 @@ extern "C" {
#endif
/**
- * @defgroup RTEMSScoreMutex Mutex Handler
+ * @defgroup RTEMSScoreMutex Mutex Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Mutex Handler
*
- * @ingroup RTEMSScore
+ * This handler encapsulates functionality which provides the foundation
+ * Mutex services used in all of the APIs supported by RTEMS.
*
- * This handler encapsulates functionality which provides the foundation
- * Mutex services used in all of the APIs supported by RTEMS.
+ * @{
*/
-/**@{*/
/**
* @brief Control block used to manage each mutex.
@@ -94,7 +99,7 @@ typedef struct {
#endif
} CORE_ceiling_mutex_Control;
-/**@}*/
+/** @} */
#ifdef __cplusplus
}
More information about the vc
mailing list