periph/timer: Document that set_absolute is expected to wrap
Most timers are implemented this way already, and keeping (documenting) it that way allows the generic timer_set implementation to stay as simple as it is.
This commit is contained in:
parent
dcb25eb3fc
commit
d8d56e5e3a
@ -149,6 +149,9 @@ int timer_set(tim_t dev, int channel, unsigned int timeout);
|
||||
/**
|
||||
* @brief Set an absolute timeout value for the given channel of the given timer
|
||||
*
|
||||
* Timers that are less wide than `unsigned int` accept and truncate overflown
|
||||
* values.
|
||||
*
|
||||
* @param[in] dev the timer device to set
|
||||
* @param[in] channel the channel to set
|
||||
* @param[in] value the absolute compare value when the callback will be
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user