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

sys/evtimer: copy warning from xtimer

Callbacks from evtimer are still executed in interrupt context.
While xtimer warns about this, evtimer leaves the user unsuspecting.

Copy the warning from xtimer to keep users vigilant.
This commit is contained in:
Benjamin Valentin 2020-09-24 11:52:56 +02:00
parent 07f0745015
commit bb2b6adb7e

View File

@ -78,6 +78,10 @@ typedef struct {
/**
* @brief Initializes an event timer
*
* @warning BEWARE! Callbacks from evtimer_init() are being executed
* in interrupt context.
* DON'T USE THIS FUNCTION unless you know *exactly* what that means.
*
* @param[in] evtimer An event timer
* @param[in] handler An event handler function
*/