ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

events: Added note about immediate firing of periodic events
pull/6211/merge
Cruz Monrreal 2018-03-15 10:48:22 -05:00 committed by GitHub
parent 69bc68d21f 30392acae3
commit b97c7d8263
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
events/EventQueue.h
View File

@ -701,6 +701,9 @@ public:
} }
/** Calls an event on the queue periodically /** 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 * The specified callback will be executed in the context of the event
* queue's dispatch loop. * queue's dispatch loop.