doc: Improve timer documentation.

[bertos.git] / bertos / drv / timer.h

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index 06f19ed31ca73076091d3b9f3d6b6a46c1058f95..b006c5f4a3037b753a2b5bb3005983a1cbf4e053 100644 (file)
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -291,7 +291,12 @@ INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
        event_initSoftint(&timer->expire, func, user_data);
 }
 
-/** Set the timer delay (the time before the event will be triggered) */
+/**
+ * Set the timer delay (the time before the event will be triggered)
+ *
+ * \note It's illegal to change the delay of the timer when it's
+ * still running.
+ */
 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 {
        timer->_delay = delay;