Updated: Doxygen Documentation

This commit is contained in:
@CarlWachter
2024-01-06 17:17:40 +01:00
committed by CarlWachter
parent b3ed26e288
commit 16b9e6135c
26 changed files with 331 additions and 306 deletions

View File

@@ -19,13 +19,13 @@ namespace sta
/**
* @brief Set event flag.
*
* @param Flag nr. to set
* @param flags nr. to set
*/
virtual void set(uint32_t flags) = 0;
/**
* @brief Clear event flag.
*
* @param Flag nr. to clear
* @param flags nr. to clear
*/
virtual void clear(uint32_t flags) = 0;
/**
@@ -37,7 +37,8 @@ namespace sta
/**
* @brief Wait until event flag is set. Timeout default to forever.
*
* @param Event flag nr. to wait for.
* @param flags flag nr. to wait for.
* @param timeout timeout in ms., default to forever.
*/
virtual uint32_t wait(uint32_t flags, uint32_t timeout = osWaitForever) = 0;
};