summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-20 08:41:42 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-20 08:42:27 +0900
commit0146e3dacc87189eba100bf5489498290ec9f86b (patch)
tree554c75c0f8224b254e70d486e04fddded88cc988
parent7bba64d7eed9749a876255f489684355a7e0ccfd (diff)
downloadefl-0146e3dacc87189eba100bf5489498290ec9f86b.tar.gz
Docs fix for ecore_animator_add fixed
Summary: Function returns boolean value, docs said it can return int. I had fixed that. Reviewers: cedric, raster Reviewed By: raster CC: cedric Differential Revision: https://phab.enlightenment.org/D342
-rw-r--r--src/lib/ecore/Ecore_Legacy.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index 0bc0009244..d7d01cef27 100644
--- a/src/lib/ecore/Ecore_Legacy.h
+++ b/src/lib/ecore/Ecore_Legacy.h
@@ -86,9 +86,9 @@ EAPI void *ecore_poller_del(Ecore_Poller *poller);
* the @p frametime interval set by ecore_animator_frametime_set(). The
* function will be passed the @p data pointer as its parameter.
*
- * When the animator @p func is called, it must return a value of either 1 or
- * 0. If it returns 1 (or ECORE_CALLBACK_RENEW), it will be called again at
- * the next tick, or if it returns 0 (or ECORE_CALLBACK_CANCEL) it will be
+ * When the animator @p func is called, it must return a boolean value.
+ * If it returns EINA_TRUE (or ECORE_CALLBACK_RENEW), it will be called again at
+ * the next tick, or if it returns EINA_FALSE (or ECORE_CALLBACK_CANCEL) it will be
* deleted automatically making any references/handles for it invalid.
*
* @note The default @p frametime value is 1/30th of a second.