From e278b47a09158a39d1ac4688bc0e03377caa32e0 Mon Sep 17 00:00:00 2001 From: dario Date: Sun, 8 Jun 2025 15:29:09 +0200 Subject: [PATCH] Updated docstrings --- include/sta/tacos/system/events.hpp | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/include/sta/tacos/system/events.hpp b/include/sta/tacos/system/events.hpp index ff850c9..53fcc84 100644 --- a/include/sta/tacos/system/events.hpp +++ b/include/sta/tacos/system/events.hpp @@ -20,6 +20,12 @@ // Custom event flags for the user (bits 0-13). // + +/** + * @brief Macro for the flag of the kth custom event. + * + * @ingroup STA_RTOS_SysEvent + */ #define STA_TACOS_CUSTOM_EVENT(k) (0x1U << k) // A mask representing all custom flags available for the user. @@ -35,6 +41,7 @@ */ #define STA_TACOS_SYSTEM_EVENTS_STARTUP (0x01U << 23) +// System event flags for different tick frequencies. #define STA_TACOS_TICK_100_Hz (0x01U << 22) #define STA_TACOS_TICK_50_Hz (0x01U << 21) #define STA_TACOS_TOCK_50_Hz (0x01U << 20) @@ -57,7 +64,7 @@ namespace sta void init(); /** - * @brief Signal system events. + * @brief Signal system events. The flag is immediately cleared afterwards. * * @param flags System event flags * @@ -69,7 +76,6 @@ namespace sta * @brief Wait for system events. * * @param flags System event flags - * @param options osFlagsWaitAll or osFlagsWaitAny (osFlagsNoClear always set) * @param timeout Wait timeout (0 = instant, osWaitForever = infinite) * * @ingroup STA_RTOS_SysEvent