Clarify uc_timer_add docs
This commit is contained in:
@@ -96,6 +96,8 @@ void uc_timers_init_ex(struct UCTimers *t, struct UCoreClock *uclock);
|
|||||||
* will be called when the timer expires, and the timer is removed from the engine
|
* will be called when the timer expires, and the timer is removed from the engine
|
||||||
* User is responsible for the lifetime and memory of the UCTimer, which must exist until
|
* User is responsible for the lifetime and memory of the UCTimer, which must exist until
|
||||||
* te timer is fired or removed.
|
* te timer is fired or removed.
|
||||||
|
* If the timer has previously been added, it will be removed first. So there
|
||||||
|
* is no need to call uc_timers_remove() to "re-schedule" a timer.
|
||||||
*
|
*
|
||||||
* @param timers timer engine to add timer to.
|
* @param timers timer engine to add timer to.
|
||||||
* @param timer timer to add
|
* @param timer timer to add
|
||||||
|
|||||||
Reference in New Issue
Block a user