Enlightenment CVS committal
Author : rephorm
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
ecore_idler.c ecore_timer.c
Log Message:
add some docs
===================================================================
RCS file: /cvs/e/e17/libs/ecore/src/lib/ecore/ecore_idler.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ecore_idler.c 6 Jan 2006 17:58:12 -0000 1.7
+++ ecore_idler.c 28 Dec 2006 03:31:44 -0000 1.8
@@ -10,6 +10,13 @@
* @param data The data to be passed to this @p func call.
* @return A idler handle if successfully added. NULL otherwise.
* @ingroup Idle_Group
+ *
+ * Add an idler handle to the event loop, returning a handle on success and
+ * NULL otherwise. The function @p func will be called repeatedly while
+ * no other events are ready to be processed, as long as it returns 1. A return
+ * of 0 deletes the idler.
+ *
+ * Idlers are useful for progressively prossessing data without blocking.
*/
EAPI Ecore_Idler *
ecore_idler_add(int (*func) (void *data), const void *data)
===================================================================
RCS file: /cvs/e/e17/libs/ecore/src/lib/ecore/ecore_timer.c,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -3 -r1.15 -r1.16
--- ecore_timer.c 6 Jan 2006 17:58:12 -0000 1.15
+++ ecore_timer.c 28 Dec 2006 03:31:44 -0000 1.16
@@ -23,6 +23,15 @@
* @param data Data to pass to @p func when it is called.
* @return A timer object on success. @c NULL on failure.
* @ingroup Ecore_Time_Group
+ *
+ * This function adds a timer and returns its handle on success and NULL on
+ * failure. The function @p func will be called every @in@ seconds. The
+ * function will be passed the @p data pointer as its parameter.
+ *
+ * When the timer @p func is called, it must return a value of either 1 or 0.
+ * If it returns 1, it will be called again at the next tick, or if it returns
+ * 0 it will be deleted automatically making any references/handles for it
+ * invalid.
*/
EAPI Ecore_Timer *
ecore_timer_add(double in, int (*func) (void *data), const void *data)
@@ -46,6 +55,9 @@
* @return The data pointer set for the timer when @ref ecore_timer_add was
* called. @c NULL is returned if the function is unsuccessful.
* @ingroup Ecore_Time_Group
+ *
+ * Note: @p timer must be a valid handle. If the timer function has already
+ * returned 0, the handle is no longer valid (and does not need to be delete).
*/
EAPI void *
ecore_timer_del(Ecore_Timer *timer)
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
