diff --git a/include/sta/rtos/timer.hpp b/include/sta/rtos/timer.hpp index c0b1525..644d6fe 100644 --- a/include/sta/rtos/timer.hpp +++ b/include/sta/rtos/timer.hpp @@ -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 *arg, osTimerType_t type = osTimerOnce);