[core] timer: Added note that timer_reset must not be executed before timer expired

Should save some users debugging time while adding no computation overhead
that would be needed for range checks
This commit is contained in:
Enrico Joerns 2014-06-04 15:00:22 +02:00
parent 01bd045570
commit 1654152193

View file

@ -76,8 +76,9 @@ timer_set(struct timer *t, clock_time_t interval)
* function will cause the timer to be stable over time, unlike the * function will cause the timer to be stable over time, unlike the
* timer_restart() function. * timer_restart() function.
* *
* \param t A pointer to the timer. * \note Must not be executed before timer expired
* *
* \param t A pointer to the timer.
* \sa timer_restart() * \sa timer_restart()
*/ */
void void