Merge pull request #13965 from adbridge/master

0xc0170 · web-flow · commit a41823a41598 · 2020-12-17T10:27:55.000Z
Clarify the time units stated in the delay and period function headers for events
diff --git a/events/include/events/Event.h b/events/include/events/Event.h
@@ -116,7 +116,8 @@ class Event<void(ArgTs...)> {
 
     /** Configure the delay of an event
      *
-     *  @param d    Millisecond delay before dispatching the event
+     *  @param d    Delay (in milliseconds) before dispatching the event, expressed as a Chrono duration.
+     *              E.g. delay(50ms)
      */
     void delay(duration d)
     {
@@ -138,7 +139,8 @@ class Event<void(ArgTs...)> {
 
     /** Configure the period of an event
      *
-     *  @param p   Millisecond period for repeatedly dispatching an event
+     *  @param p   Period (in milliseconds) for repeatedly dispatching an event, expressed as a Chrono duration.
+     *             E.g. period(200ms)
      */
     void period(duration p)
     {

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,8 @@ class Event<void(ArgTs...)> {`
`116`	`116`
`117`	`117`	`/** Configure the delay of an event`
`118`	`118`	`*`
`119`		`- * @param d Millisecond delay before dispatching the event`
	`119`	`+ * @param d Delay (in milliseconds) before dispatching the event, expressed as a Chrono duration.`
	`120`	`+ * E.g. delay(50ms)`
`120`	`121`	`*/`
`121`	`122`	`void delay(duration d)`
`122`	`123`	`{`
`@@ -138,7 +139,8 @@ class Event<void(ArgTs...)> {`
`138`	`139`
`139`	`140`	`/** Configure the period of an event`
`140`	`141`	`*`
`141`		`- * @param p Millisecond period for repeatedly dispatching an event`
	`142`	`+ * @param p Period (in milliseconds) for repeatedly dispatching an event, expressed as a Chrono duration.`
	`143`	`+ * E.g. period(200ms)`
`142`	`144`	`*/`
`143`	`145`	`void period(duration p)`
`144`	`146`	`{`