events: Added note about immediate firing of periodic events

2018-03-05 11:07:28 -06:00 · 2018-03-05 11:07:28 -06:00 · 2e9a0ebd25
parent b2e31fb0d9
commit 2e9a0ebd25
1 changed files with 3 additions and 0 deletions
--- a/events/EventQueue.h
+++ b/events/EventQueue.h
@ -701,6 +701,9 @@ public:
    }

    /** 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.