From: Carsten Haitzler (Rasterman) <raster@rasterman.com>
Date: Tue, 19 Nov 2013 23:41:42 +0000 (+0900)
Subject: Docs fix for ecore_animator_add fixed
X-Git-Tag: v1.8.0-beta1~45
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0146e3dacc87189eba100bf5489498290ec9f86b;p=platform%2Fupstream%2Fefl.git

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
---

diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index 0bc0009..d7d01ce 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.