From b1ff37cdee4f9986d3642d09659d29be1e4386ed Mon Sep 17 00:00:00 2001 From: Filip Jagodzinski Date: Tue, 5 Sep 2017 13:31:12 +0200 Subject: [PATCH] HAL: ticker_api: Fix outdated comment --- hal/ticker_api.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/hal/ticker_api.h b/hal/ticker_api.h index fceba2db87..aaa063dd2b 100644 --- a/hal/ticker_api.h +++ b/hal/ticker_api.h @@ -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. * - * @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