Merge pull request #5019 from fkjagodzinski/fix-ticker_API_docs

theotherjimmy · web-flow · commit 8beedcef83e8 · 2017-10-09T11:11:36.000-05:00
Fix an incorrect comment in ticker API
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -132,8 +132,9 @@ void ticker_insert_event(const ticker_data_t const ticker, ticker_event_t obj,`
`132`	`132`	`*`
`133`	`133`	`* The event will be executed in timestamp - ticker_read_us() us.`
`134`	`134`	`*`
`135`		`- * @warning If an event is inserted with a timestamp less than the current`
`136`		`- * timestamp then the event will not be inserted.`
	`135`	`+ * @note If an event is inserted with a timestamp less than the current`
	`136`	`+ * timestamp then the event will be scheduled immediately resulting in`
	`137`	`+ * an instant call to event handler.`
`137`	`138`	`*`
`138`	`139`	`* @param ticker The ticker object.`
`139`	`140`	`* @param obj The event object to be inserted to the queue`