summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-11 15:01:48 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-11 16:52:43 +0200
commit05a66cebc0aeb8b853837d0d4085cb6675b47fe0 (patch)
tree9a2f6ac5b6af048d8f2e8ddf95311cb7d0158eb7
parentedcfc6d036fa8b838bba61fe0819ebb0e6652b53 (diff)
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.
-rw-r--r--src/lib/ecore/ecore_animator.eo18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/lib/ecore/ecore_animator.eo b/src/lib/ecore/ecore_animator.eo
index d250691bb7..3a895eccd8 100644
--- a/src/lib/ecore/ecore_animator.eo
+++ b/src/lib/ecore/ecore_animator.eo
@@ -2,23 +2,29 @@ import ecore_types;
2 2
3class Ecore.Animator (Eo.Base) 3class Ecore.Animator (Eo.Base)
4{ 4{
5 [[Helper to simplify creating animations.
6
7 Creating an animation is as simple as saying for how long it
8 should be run and having a callback that does the animation.
9 ]]
10
5 eo_prefix: ecore_animator; 11 eo_prefix: ecore_animator;
6 methods { 12 methods {
7 timeline_constructor { 13 timeline_constructor {
8 [[Constructor.]] 14 [[Timeline constructor.]]
9 legacy: null; 15 legacy: null;
10 params { 16 params {
11 @in runtime: double; 17 @in runtime: double; [[Animation runtime in seconds.]]
12 @in func: Ecore_Timeline_Cb; 18 @in func: Ecore_Timeline_Cb; [[Animation callback function.]]
13 @in data: const(void)*; 19 @in data: const(void)*; [[Private data passed to callback functions.]]
14 } 20 }
15 } 21 }
16 constructor { 22 constructor {
17 [[Constructor.]] 23 [[Constructor.]]
18 legacy: null; 24 legacy: null;
19 params { 25 params {
20 @in func: Ecore_Task_Cb; 26 @in func: Ecore_Task_Cb; [[Animation callback function.]]
21 @in data: const(void)*; 27 @in data: const(void)*; [[Private data passed to callback functions.]]
22 } 28 }
23 } 29 }
24 } 30 }