[rtems commit] score: Add Doxygen group for <sys/lock.h> mutexes

Sebastian Huber sebh at rtems.org
Thu Sep 30 05:29:41 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Sep 24 10:04:03 2021 +0200

score: Add Doxygen group for <sys/lock.h> mutexes

---

 cpukit/score/src/mutex.c | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/cpukit/score/src/mutex.c b/cpukit/score/src/mutex.c
index f7e3509..92bd614 100644
--- a/cpukit/score/src/mutex.c
+++ b/cpukit/score/src/mutex.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup RTEMSScore
+ * @ingroup RTEMSScoreSysLockMutex
  *
  * @brief This source file contains the implementation of
  *   _Mutex_Acquire(), _Mutex_Acquire_timed(), _Mutex_Acquire_timed_ticks(),
@@ -36,6 +36,20 @@
 #include <rtems/score/threadimpl.h>
 #include <rtems/score/todimpl.h>
 
+/**
+ * @defgroup RTEMSScoreSysLockMutex System Lock Mutex Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief This group contains the System Lock Mutex Handler implementation.
+ *
+ * The interfaces are defined by Newlib in <sys/lock.h>.  The system lock
+ * mutexes are used for Newlib internal locking, the C++ standard library
+ * provided by GCC, the OpenMP support provided by GCC, the self-contained
+ * objects API provided by RTEMS, and the SuperCore internal mutexes such as
+ * the objects allocator lock (see ::API_Mutex_Control).
+ */
+
 #define MUTEX_TQ_OPERATIONS &_Thread_queue_Operations_priority_inherit
 
 RTEMS_STATIC_ASSERT(



More information about the vc mailing list