[rtems commit] doxygen: score: adjust doc in muteximpl.h to doxygen guidelines

Sebastian Huber sebh at rtems.org
Mon May 13 05:52:29 UTC 2019


Module:    rtems
Branch:    master
Commit:    2463c100ccfb86d2bbc57ca86cccbe9db583a849
Changeset: http://git.rtems.org/rtems/commit/?id=2463c100ccfb86d2bbc57ca86cccbe9db583a849

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr 18 09:43:41 2019 +0200

doxygen: score: adjust doc in muteximpl.h to doxygen guidelines

Update #3706.

---

 cpukit/include/rtems/score/muteximpl.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/cpukit/include/rtems/score/muteximpl.h b/cpukit/include/rtems/score/muteximpl.h
index 5fd4f5e..aac55fa 100644
--- a/cpukit/include/rtems/score/muteximpl.h
+++ b/cpukit/include/rtems/score/muteximpl.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreAPIMutex
+ *
+ * @brief Structures for the implementation of mutexes.
+ */
+
 /*
  * Copyright (c) 2015, 2017 embedded brains GmbH.  All rights reserved.
  *
@@ -17,6 +25,12 @@
 
 #include <rtems/score/threadqimpl.h>
 
+/**
+ * @addtogroup RTEMSScoreAPIMutex
+ *
+ * @{
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
@@ -34,4 +48,6 @@ typedef struct {
 }
 #endif /* __cplusplus */
 
+/** @} */
+
 #endif /* _RTEMS_SCORE_MUTEXIMPL_H */



More information about the vc mailing list