stefan pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=05a66cebc0aeb8b853837d0d4085cb6675b47fe0

commit 05a66cebc0aeb8b853837d0d4085cb6675b47fe0
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date:   Mon Apr 11 15:01:48 2016 +0200

    docs: document ecore_animator EO class.
    
    Keep it brief as we want the larger parts being editable from the wiki part 
of
    the new doc system.
---
 src/lib/ecore/ecore_animator.eo | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/lib/ecore/ecore_animator.eo b/src/lib/ecore/ecore_animator.eo
index d250691..3a895ec 100644
--- a/src/lib/ecore/ecore_animator.eo
+++ b/src/lib/ecore/ecore_animator.eo
@@ -2,23 +2,29 @@ import ecore_types;
 
 class Ecore.Animator (Eo.Base)
 {
+   [[Helper to simplify creating animations.
+
+   Creating an animation is as simple as saying for how long it
+   should be run and having a callback that does the animation.
+   ]]
+
    eo_prefix: ecore_animator;
    methods {
       timeline_constructor {
-         [[Constructor.]]
+         [[Timeline constructor.]]
          legacy: null;
          params {
-            @in runtime: double;
-            @in func: Ecore_Timeline_Cb;
-            @in data: const(void)*;
+            @in runtime: double; [[Animation runtime in seconds.]]
+            @in func: Ecore_Timeline_Cb; [[Animation callback function.]]
+            @in data: const(void)*; [[Private data passed to callback 
functions.]]
          }
       }
       constructor {
          [[Constructor.]]
          legacy: null;
          params {
-            @in func: Ecore_Task_Cb;
-            @in data: const(void)*;
+            @in func: Ecore_Task_Cb; [[Animation callback function.]]
+            @in data: const(void)*; [[Private data passed to callback 
functions.]]
          }
       }
    }

-- 


Reply via email to