ALPAKA/rtos2-utils
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git synced 2025-06-10 01:55:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Nicer Doxygen categorization

Browse Source
This commit is contained in:
@CarlWachter 2024-01-06 16:38:58 +01:00
parent b4b214a756
commit f193cde9be
7 changed files with 17 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/sta/rtos/defs.hpp
View File

@ -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

8
include/sta/rtos/event.hpp
View File

@ -9,18 +9,12 @@
#include <cmsis_os2.h>
#include <sta/event.hpp>
/**
* @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
{

8
include/sta/rtos/mempool.hpp
View File

@ -9,12 +9,6 @@
#include <cstdint>
/**
* @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 <typename T>
class RtosMemPool

8
include/sta/rtos/mutex.hpp
View File

@ -9,17 +9,11 @@
#include <cmsis_os2.h>
/**
* @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
{

8
include/sta/rtos/queue.hpp
View File

@ -9,12 +9,6 @@
#include <cstdint>
/**
* @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 <typename T>
class RtosQueue

9
include/sta/rtos/sharedmem.hpp
View File

@ -9,13 +9,6 @@
#include <cstdint>
/**
* @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 <typename T>
class RtosSharedMem

8
include/sta/rtos/signal.hpp
View File

@ -9,18 +9,12 @@
#include <cmsis_os2.h>
/**
* @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