Drivers: TimerEvent: Update API docs

pull/5046/head
Filip Jagodzinski 2017-09-05 15:50:21 +02:00
parent 1d1eef47ff
commit 7f73785b9a
1 changed files with 21 additions and 3 deletions

View File

@ -47,13 +47,31 @@ protected:
// The handler called to service the timer event of the derived class
virtual void handler() = 0;
// insert relative timestamp in to linked list
/** Set relative timestamp of the internal event.
* @param timestamp event's us timestamp
*
* @warning
* Do not insert more than one timestamp.
* The same @a event object is used for every @a insert/insert_absolute call.
*
* @warning
* Ticker's present timestamp is used for reference. For timestamps
* from the past the event is scheduled after ticker's overflow.
* For reference @see convert_timestamp
*/
void insert(timestamp_t timestamp);
// insert absolute timestamp into linked list
/** Set absolute timestamp of the internal event.
* @param timestamp event's us timestamp
*
* @warning
* Do not insert more than one timestamp.
* The same @a event object is used for every @a insert/insert_absolute call.
*/
void insert_absolute(us_timestamp_t timestamp);
// remove from linked list, if in it
/** Remove timestamp.
*/
void remove();
ticker_event_t event;