From f193cde9be50d805995b72d9dc76c1678c9c6082 Mon Sep 17 00:00:00 2001 From: "@CarlWachter" Date: Sat, 6 Jan 2024 16:38:58 +0100 Subject: [PATCH] Nicer Doxygen categorization --- include/sta/rtos/defs.hpp | 11 +++++++++++ include/sta/rtos/event.hpp | 8 +------- include/sta/rtos/mempool.hpp | 8 +------- include/sta/rtos/mutex.hpp | 8 +------- include/sta/rtos/queue.hpp | 8 +------- include/sta/rtos/sharedmem.hpp | 9 +-------- include/sta/rtos/signal.hpp | 8 +------- 7 files changed, 17 insertions(+), 43 deletions(-) diff --git a/include/sta/rtos/defs.hpp b/include/sta/rtos/defs.hpp index 55bf902..6b5fdfb 100644 --- a/include/sta/rtos/defs.hpp +++ b/include/sta/rtos/defs.hpp @@ -22,6 +22,17 @@ * @brief Build configuration options. */ +/** + * @defgroup STA_RTOS_IPC Interprocess communication + * @ingroup STA_RTOS_API + * @brief Classes for interprocess communication. + */ + +/** + * @defgroup STA_RTOS_Sync Process synchronization + * @ingroup STA_RTOS_API + * @brief Classes for process synchronization. + */ /** * @ingroup STA_RTOS_API diff --git a/include/sta/rtos/event.hpp b/include/sta/rtos/event.hpp index 8d9de03..99d9624 100644 --- a/include/sta/rtos/event.hpp +++ b/include/sta/rtos/event.hpp @@ -9,18 +9,12 @@ #include #include -/** - * @defgroup STA_RTOS_EVENT Event - * @ingroup STA_RTOS_API - * @brief CMSIS RTOS2 Event. - */ - namespace sta { /** * @brief Implementation of Event using CMSIS RTOS2. * - * @ingroup STA_RTOS_EVENT + * @ingroup STA_RTOS_Sync */ class RtosEvent : public Event { diff --git a/include/sta/rtos/mempool.hpp b/include/sta/rtos/mempool.hpp index 693af70..048d4c2 100644 --- a/include/sta/rtos/mempool.hpp +++ b/include/sta/rtos/mempool.hpp @@ -9,12 +9,6 @@ #include -/** - * @defgroup STA_RTOS_MEMPOOL MemPool - * @ingroup STA_RTOS_API - * @brief RTOS Memory Pool. - */ - namespace sta { /** @@ -22,7 +16,7 @@ namespace sta * * @tparam Message type * - * @ingroup STA_RTOS_MEMPOOL + * @ingroup STA_RTOS_IPC */ template class RtosMemPool diff --git a/include/sta/rtos/mutex.hpp b/include/sta/rtos/mutex.hpp index ff05415..9f420a6 100644 --- a/include/sta/rtos/mutex.hpp +++ b/include/sta/rtos/mutex.hpp @@ -9,17 +9,11 @@ #include -/** - * @defgroup STA_RTOS_MUTEX Mutex - * @ingroup STA_RTOS_API - * @brief RTOS Mutexes. - */ - namespace sta { /** * @brief Implementation of Mutex interface using CMSIS RTOS2. - * @ingroup STA_RTOS_MUTEX + * @ingroup STA_RTOS_Sync */ class RtosMutex : public Mutex { diff --git a/include/sta/rtos/queue.hpp b/include/sta/rtos/queue.hpp index 3721646..51d5442 100644 --- a/include/sta/rtos/queue.hpp +++ b/include/sta/rtos/queue.hpp @@ -9,12 +9,6 @@ #include -/** - * @defgroup STA_RTOS_QUEUE Queue - * @ingroup STA_RTOS_API - * @brief RTOS Queue. - */ - namespace sta { /** @@ -22,7 +16,7 @@ namespace sta * * @tparam Message type * - * @ingroup STA_RTOS_QUEUE + * @ingroup STA_RTOS_IPC */ template class RtosQueue diff --git a/include/sta/rtos/sharedmem.hpp b/include/sta/rtos/sharedmem.hpp index 9e057cd..7392a8a 100644 --- a/include/sta/rtos/sharedmem.hpp +++ b/include/sta/rtos/sharedmem.hpp @@ -9,13 +9,6 @@ #include -/** - * @defgroup STA_RTOS_SHAREDMEM SharedMem - * @ingroup STA_RTOS_API - * @brief RTOS Shared Memory. - */ - - namespace sta { /** @@ -23,7 +16,7 @@ namespace sta * * @tparam Message type * - * @ingroup STA_RTOS_SHAREDMEM + * @ingroup STA_RTOS_IPC */ template class RtosSharedMem diff --git a/include/sta/rtos/signal.hpp b/include/sta/rtos/signal.hpp index 39d6a5c..6ede2cb 100644 --- a/include/sta/rtos/signal.hpp +++ b/include/sta/rtos/signal.hpp @@ -9,18 +9,12 @@ #include -/** - * @defgroup STA_RTOS_SIGNAL Signal - * @ingroup STA_RTOS_API - * @brief RTOS Signal. - */ - namespace sta { /** * @brief Implementation of Signal interface using CMSIS RTOS2. * - * @ingroup STA_RTOS_SIGNAL + * @ingroup STA_RTOS_Sync * */ class RtosSignal : public Signal