Timer Documentation extended for timer types

This commit is contained in:
@CarlWachter 2024-06-01 12:02:10 +02:00
parent dcc647a062
commit 1d77846e9e

View File

@ -26,10 +26,13 @@ namespace sta
{
public:
/**
* @brief
* @brief Creates a new timer with a given callback function.
*
* @param callback The callback function to call upon timer timeout.
* @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);