Skip to content

Commit 35d913b

Browse files
committed
Drivers: TimerEvent: Update API docs
1 parent 494c25d commit 35d913b

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

drivers/TimerEvent.h

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,31 @@ class TimerEvent : private NonCopyable<TimerEvent> {
4747
// The handler called to service the timer event of the derived class
4848
virtual void handler() = 0;
4949

50-
// insert relative timestamp in to linked list
50+
/** Set relative timestamp of the internal event.
51+
* @param timestamp event's us timestamp
52+
*
53+
* @warning
54+
* Do not insert more than one timestamp.
55+
* The same @a event object is used for every @a insert/insert_absolute call.
56+
*
57+
* @warning
58+
* Ticker's present timestamp is used for reference. For timestamps
59+
* from the past the event is scheduled after ticker's overflow.
60+
* For reference @see convert_timestamp
61+
*/
5162
void insert(timestamp_t timestamp);
5263

53-
// insert absolute timestamp into linked list
64+
/** Set absolute timestamp of the internal event.
65+
* @param timestamp event's us timestamp
66+
*
67+
* @warning
68+
* Do not insert more than one timestamp.
69+
* The same @a event object is used for every @a insert/insert_absolute call.
70+
*/
5471
void insert_absolute(us_timestamp_t timestamp);
5572

56-
// remove from linked list, if in it
73+
/** Remove timestamp.
74+
*/
5775
void remove();
5876

5977
ticker_event_t event;

0 commit comments

Comments
 (0)