Full Doxygen documentation

This commit is contained in:
@CarlWachter
2024-01-06 16:30:30 +01:00
parent b30d47413b
commit b4b214a756
10 changed files with 137 additions and 111 deletions

View File

@@ -9,13 +9,17 @@
#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_API
* @ingroup STA_RTOS_MUTEX
*/
class RtosMutex : public Mutex
{
@@ -32,7 +36,14 @@ namespace sta
*/
RtosMutex(const char* name);
/**
* @brief Acquire the mutex.
*/
void acquire() override;
/**
* @brief Release the mutex.
*/
void release() override;
private: