Skip to content

Commit 95f40aa

Browse files
committed
Fix the time units stated in the delay and period functon headers
delay() and period() still stated that the units were milliseconds whereas in fact they are now a Chrono duration.
1 parent 66ca70a commit 95f40aa

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

events/include/events/Event.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ class Event<void(ArgTs...)> {
116116

117117
/** Configure the delay of an event
118118
*
119-
* @param d Millisecond delay before dispatching the event
119+
* @param d Chrono duration delay before dispatching the event. For example delay(5s)
120120
*/
121121
void delay(duration d)
122122
{
@@ -138,7 +138,7 @@ class Event<void(ArgTs...)> {
138138

139139
/** Configure the period of an event
140140
*
141-
* @param p Millisecond period for repeatedly dispatching an event
141+
* @param p Chrono duration period for repeatedly dispatching an event. For example period(5s)
142142
*/
143143
void period(duration p)
144144
{

0 commit comments

Comments
 (0)