ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

HAL: ticker_api: Fix outdated comment

pull/5019/head
Filip Jagodzinski 2017-09-05 13:31:12 +02:00
parent 5bddd881e9
commit b1ff37cdee
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hal/ticker_api.h
View File

@ -132,8 +132,9 @@ void ticker_insert_event(const ticker_data_t *const ticker, ticker_event_t *obj,
* *
* The event will be executed in timestamp - ticker_read_us() us. * The event will be executed in timestamp - ticker_read_us() us.
* *
* @warning If an event is inserted with a timestamp less than the current * @note If an event is inserted with a timestamp less than the current
* timestamp then the event will **not** be inserted. * timestamp then the event will be scheduled immediately resulting in
* an instant call to event handler.
* *
* @param ticker The ticker object. * @param ticker The ticker object.
* @param obj The event object to be inserted to the queue * @param obj The event object to be inserted to the queue