SilentSensors / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

Diff: hal/ticker_api.h

Revision:
176:447f873cad2f
Parent:
174:b96e65c34a4d
Child:
180:96ed750bd169
--- 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