Merge pull request #6274 from geky/events-doc-periodic

cmonr · web-flow · commit b97c7d826373 · 2018-03-15T10:48:22.000-05:00
events: Added note about immediate firing of periodic events
diff --git a/events/EventQueue.h b/events/EventQueue.h
@@ -701,6 +701,9 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
     }
 
     /** Calls an event on the queue periodically
+     *
+     *  @note The first call_every event occurs after the specified delay.
+     *  To create a periodic event that fires immediately, @see Event.
      *
      *  The specified callback will be executed in the context of the event
      *  queue's dispatch loop.

Original file line number	Diff line number	Diff line change
`@@ -701,6 +701,9 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {`
`701`	`701`	`}`
`702`	`702`
`703`	`703`	`/** Calls an event on the queue periodically`
	`704`	`+ *`
	`705`	`+ * @note The first call_every event occurs after the specified delay.`
	`706`	`+ * To create a periodic event that fires immediately, @see Event.`
`704`	`707`	`*`
`705`	`708`	`* The specified callback will be executed in the context of the event`
`706`	`709`	`* queue's dispatch loop.`