From 99d5373b839ba5886f54cf255f6d800e9ea8688a Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Fri, 24 Sep 2021 10:04:03 +0200
Subject: score: Add Doxygen group for <sys/lock.h> mutexes

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

(limited to 'cpukit/score/src/mutex.c')

diff --git a/cpukit/score/src/mutex.c b/cpukit/score/src/mutex.c
index f7e35093b2..92bd614967 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(
-- 
cgit v1.2.3