From 81e293422cc4fb8930db8a66f9e7b4881ecdf3de Mon Sep 17 00:00:00 2001
From: Sebastian Meiling <s@mlng.net>
Date: Mon, 7 Jan 2019 15:34:15 +0100
Subject: [PATCH] doxygen: refine core_sync grouping
- Move `@defgroup core_sync` group definition to doc.txt
- Adapt usage of `@ingroup core_sync` accordingly
---
core/doc.txt | 6 ++++++
core/include/cond.h | 12 +++++++-----
core/include/mutex.h | 6 +++---
core/include/rmutex.h | 4 +++-
4 files changed, 19 insertions(+), 9 deletions(-)
diff --git a/core/doc.txt b/core/doc.txt
index eba36071d8..e1406bda7a 100644
--- a/core/doc.txt
+++ b/core/doc.txt
@@ -25,3 +25,9 @@
* @ingroup core
* @brief Configuration data and startup code for the kernel
*/
+
+ /**
+ * @defgroup core_sync Thread Synchronization
+ * @ingroup core
+ * @brief Thread synchronization mechanisms of the kernel
+ */
diff --git a/core/include/cond.h b/core/include/cond.h
index 38c14677a2..67520c7418 100644
--- a/core/include/cond.h
+++ b/core/include/cond.h
@@ -5,12 +5,9 @@
*/
/**
+ * @defgroup core_sync_cond Condition Variable
+ * @ingroup core_sync
* @brief Condition variable for thread synchronization
- * @ingroup core, core_sync
- * @{
- *
- * @file
- * @brief RIOT synchronization API
*
* This file contains a condition variable with Mesa-style semantics.
*
@@ -129,6 +126,11 @@
* Note that this could actually be written with a single condition variable.
* However, the example includes two for didactic reasons.
*
+ * @{
+ *
+ * @file
+ * @brief Condition variable for thread synchronization
+ *
* @author Sam Kumar <samkumar@berkeley.edu>
*/
diff --git a/core/include/mutex.h b/core/include/mutex.h
index 9a29eb5f7e..f41a5ae9bc 100644
--- a/core/include/mutex.h
+++ b/core/include/mutex.h
@@ -8,13 +8,13 @@
*/
/**
- * @defgroup core_sync Synchronization
+ * @defgroup core_sync_mutex Mutex
+ * @ingroup core_sync
* @brief Mutex for thread synchronization
- * @ingroup core
* @{
*
* @file
- * @brief RIOT synchronization API
+ * @brief Mutex for thread synchronization
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
diff --git a/core/include/rmutex.h b/core/include/rmutex.h
index ef8c0692c6..77553fb405 100644
--- a/core/include/rmutex.h
+++ b/core/include/rmutex.h
@@ -7,12 +7,14 @@
*/
/**
+ * @defgroup core_sync_rmutex Recursive Mutex
* @ingroup core_sync
* @brief Recursive Mutex for thread synchronization
+ *
* @{
*
* @file
- * @brief RIOT synchronization API
+ * @brief Recursive Mutex for thread synchronization
*
* @author Martin Elshuber <martin.elshuber@theobroma-systems.com>
*
--
GitLab