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

Updated docstrings

Browse Source
This commit is contained in:
dario 2025-06-08 15:29:09 +02:00
parent 4faeb1e6b0
commit e278b47a09
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/sta/tacos/system/events.hpp
View File

@ -20,6 +20,12 @@
// Custom event flags for the user (bits 0-13). // 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) #define STA_TACOS_CUSTOM_EVENT(k) (0x1U << k)
// A mask representing all custom flags available for the user. // A mask representing all custom flags available for the user.
@ -35,6 +41,7 @@
*/ */
#define STA_TACOS_SYSTEM_EVENTS_STARTUP (0x01U << 23) #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_100_Hz (0x01U << 22)
#define STA_TACOS_TICK_50_Hz (0x01U << 21) #define STA_TACOS_TICK_50_Hz (0x01U << 21)
#define STA_TACOS_TOCK_50_Hz (0x01U << 20) #define STA_TACOS_TOCK_50_Hz (0x01U << 20)
@ -57,7 +64,7 @@ namespace sta
void init(); void init();
/** /**
* @brief Signal system events. * @brief Signal system events. The flag is immediately cleared afterwards.
* *
* @param flags System event flags * @param flags System event flags
* *
@ -69,7 +76,6 @@ namespace sta
* @brief Wait for system events. * @brief Wait for system events.
* *
* @param flags System event flags * @param flags System event flags
* @param options osFlagsWaitAll or osFlagsWaitAny (osFlagsNoClear always set)
* @param timeout Wait timeout (0 = instant, osWaitForever = infinite) * @param timeout Wait timeout (0 = instant, osWaitForever = infinite)
* *
* @ingroup STA_RTOS_SysEvent * @ingroup STA_RTOS_SysEvent