From: batt <batt@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Sat, 9 Aug 2008 10:04:15 +0000 (+0000)
Subject: Add documentation.
X-Git-Tag: 2.0.0~351
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=aa634d4ea6f4465f1c5e2769093b0653edfb889e;p=bertos.git

Add documentation.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@1583 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/drv/timer.c b/bertos/drv/timer.c
index fbe7c695..aa671dc4 100644
--- 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)
 {