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

Timer Documentation extended for timer types

Browse Source
This commit is contained in:
@CarlWachter 2024-06-01 12:02:10 +02:00
parent dcc647a062
commit 1d77846e9e
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/sta/rtos/timer.hpp
View File

@ -26,10 +26,13 @@ namespace sta
{ {
public: public:
/** /**
* @brief * @brief Creates a new timer with a given callback function.
* *
* @param callback The callback function to call upon timer timeout. * @param callback The callback function to call upon timer timeout.
* @param arg The argument to pass to the callback function. * @param arg The argument to pass to the callback function.
* @param type The type of timer to create. The Options are:
* - osTimerOnce: One-shot timer.
* - osTimerPeriodic: Repeating timer.
*/ */
RtosTimer(std::function<void(void*)>, void *arg, osTimerType_t type = osTimerOnce); RtosTimer(std::function<void(void*)>, void *arg, osTimerType_t type = osTimerOnce);