Add documentation.

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

diff --git a/bertos/drv/timer.c b/bertos/drv/timer.c
index fbe7c695c9ee3455cd6cdde428c4ca860b6426a8..aa671dc4d9423e8f50c0008ffc237212ec58a9e5 100644 (file)
--- a/bertos/drv/timer.c
+++ b/bertos/drv/timer.c
@@ -163,7 +163,9 @@ void timer_add(Timer *timer)
 
 
 /**
- * Remove a timer from the timer queue before it has expired.
+ * Remove a timer from the timers queue before it has expired.
+ * \note Attempting to remove a timer already expired cause
+ *       undefined behaviour.
  */
 Timer *timer_abort(Timer *timer)
 {