1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00

Merge pull request #3790 from kaspar030/fix_xtimer_usleep_until_doxygen

sys: xtimer: fix xtimer_usleep_until doxygen
This commit is contained in:
Hauke Petersen 2015-09-07 17:12:07 +02:00
commit 44d4c46fc0

View File

@ -155,14 +155,15 @@ static inline void xtimer_spin(uint32_t microseconds);
* @brief will cause the calling thread to be suspended until the absolute
* time (@p last_wakeup + @p interval).
*
* When the function returns, @p last_wakeup is set to xtimer_now().
* When the function returns, @p last_wakeup is set to
* (@p last_wakeup + @p interval).
*
* This function can be used to create periodic wakeups.
* @c last_wakeup should be set to xtimer_now() before first call of the
* function.
*
* If the result of (@p last_wakeup + usecs) would be in the past, the function
* sets @p last_wakeup to xtimer_now() and returns immediately.
* sets @p last_wakeup to @p last_wakeup + @p interval and returns immediately.
*
* @param[in] last_wakeup base time for the wakeup
* @param[in] usecs time in microseconds that will be added to