Skip to content

Fix an incorrect comment in ticker API #5019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2017
Merged

Fix an incorrect comment in ticker API #5019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions hal/ticker_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down