anyThing Connected Team / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   BREAK_SENSOR_LED

Fork of mbed-dev by mbed official

Diff: hal/ticker_api.h

Revision:
176:447f873cad2f
Parent:
174:b96e65c34a4d
diff -r af195413fb11 -r 447f873cad2f hal/ticker_api.h
--- a/hal/ticker_api.h	Wed Oct 11 12:45:49 2017 +0100
+++ b/hal/ticker_api.h	Wed Oct 25 14:53:38 2017 +0100
@@ -132,8 +132,9 @@
  *
  * The event will be executed in timestamp - ticker_read_us() us.
  *
- * @warning If an event is inserted with a timestamp less than the current
- * timestamp then the event will **not** be inserted.
+ * @note If an event is inserted with a timestamp less than the current
+ * timestamp then the event will be scheduled immediately resulting in
+ * an instant call to event handler.
  *
  * @param ticker    The ticker object.
  * @param obj       The event object to be inserted to the queue