dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ecore idlers doc bump. 

SVN revision: 69112
This commit is contained in:
Jonas M. Gastal 2012-03-09 17:31:47 +00:00
parent 531ea0831d
commit d829bf73ce
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
legacy/ecore/src/lib/ecore/Ecore.h
View File

@ -1271,14 +1271,15 @@ EAPI char *ecore_timer_dump(void);
/** /**
* @defgroup Ecore_Idle_Group Ecore Idle functions * @defgroup Ecore_Idle_Group Ecore Idle functions
* *
* Callbacks that are called when the program enters or exits an * The idler functionality in Ecore allows for callbacks to be called when the
* idle state. * program isn't handling @ref Ecore_Event_Group "events", @ref Ecore_Time_Group
* "timers" or @ref Ecore_FD_Handler_Group "fd handlers".
* *
* The ecore main loop enters an idle state when it is waiting for * There are three types of idlers: Enterers, Idlers(proper) and Exiters. They
* timers to time out, data to come in on a file descriptor or any * are called, respectively, when the program is about to enter an idle state,
* other event to occur. You can set callbacks to be called when * when the program is in an idle state and when the program has just left an
* the main loop enters an idle state, during an idle state or just * idle state and will begin processing @ref Ecore_Event_Group "events", @ref
* after the program wakes up. * Ecore_Time_Group "timers" or @ref Ecore_FD_Handler_Group "fd handlers".
* *
* Enterer callbacks are good for updating your program's state, if * Enterer callbacks are good for updating your program's state, if
* it has a state engine. Once all of the enterer handlers are * it has a state engine. Once all of the enterer handlers are
@ -1288,14 +1289,13 @@ EAPI char *ecore_timer_dump(void);
* enterer handlers. They are useful for interfaces that require * enterer handlers. They are useful for interfaces that require
* polling and timers would be too slow to use. * polling and timers would be too slow to use.
* *
* Exiter callbacks are called when the main loop wakes up from an idle state.
*
* If no idler callbacks are specified, then the process literally * If no idler callbacks are specified, then the process literally
* goes to sleep. Otherwise, the idler callbacks are called * goes to sleep. Otherwise, the idler callbacks are called
* continuously while the loop is "idle", using as much CPU as is * continuously while the loop is "idle", using as much CPU as is
* available to the process. * available to the process.
* *
* Exiter callbacks are called when the main loop wakes up from an
* idle state.
*
* @note Idle state doesn't mean that the @b program is idle, but * @note Idle state doesn't mean that the @b program is idle, but
* that the <b>main loop</b> is idle. It doesn't have any timers, * that the <b>main loop</b> is idle. It doesn't have any timers,
* events, fd handlers or anything else to process (which in most * events, fd handlers or anything else to process (which in most