summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-10-30 15:26:08 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-11-04 13:51:21 +0100
commit0e71e0e286d97c4aaee76f1c079e2f00fc616cbf (patch)
tree0c814991b41d16d504febd787e554873ffab4037
parent56d541fbdb1cdc980dcdee644be24d52255af3fb (diff)
docs: Polish Efl.Canvas.Animation_Group and sons
Summary: These docs were almost empty. Reviewers: bu5hm4n, zmike, cedric, Jaehyun_Cho Reviewed By: cedric Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10564
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_group.eo19
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo9
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo10
3 files changed, 29 insertions, 9 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_animation_group.eo b/src/lib/evas/canvas/efl_canvas_animation_group.eo
index fdf42e2d88..f9cada25a7 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_group.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_group.eo
@@ -1,24 +1,29 @@
1abstract @beta Efl.Canvas.Animation_Group extends Efl.Canvas.Animation 1abstract @beta Efl.Canvas.Animation_Group extends Efl.Canvas.Animation
2{ 2{
3 [[Efl group animation abstract class]] 3 [[Base class for combined animations (groups of animations that are played together).
4
5 This class provides methods to add, remove and retrieve individual animations from the group.
6
7 See for example @Efl.Canvas.Animation_Group_Parallel and @Efl.Canvas.Animation_Group_Sequential.
8 ]]
4 c_prefix: efl_animation_group; 9 c_prefix: efl_animation_group;
5 data: Efl_Canvas_Animation_Group_Data; 10 data: Efl_Canvas_Animation_Group_Data;
6 methods { 11 methods {
7 animation_add { 12 animation_add {
8 [[Add the given animation to the animation group.]] 13 [[Adds the given animation to the animation group.]]
9 params { 14 params {
10 @in animation: Efl.Canvas.Animation; [[The animation which needs to be added to the animation group]] 15 @in animation: Efl.Canvas.Animation; [[Animation to add to the group.]]
11 } 16 }
12 } 17 }
13 animation_del { 18 animation_del {
14 [[Delete the given animation from the animation group.]] 19 [[Removes the given animation from the animation group.]]
15 params { 20 params {
16 @in animation: Efl.Canvas.Animation; [[The animation which needs to be deleted from the animation group]] 21 @in animation: Efl.Canvas.Animation; [[Animation to remove from the group.]]
17 } 22 }
18 } 23 }
19 animations_get @const { 24 animations_get @const {
20 [[Get the animations of the animation group.]] 25 [[Gets the list of animations currently in the animation group.]]
21 return: list<Efl.Canvas.Animation>; [[The animations of the animation group]] 26 return: list<Efl.Canvas.Animation>; [[List of animations in the group.]]
22 } 27 }
23 } 28 }
24 implements { 29 implements {
diff --git a/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo b/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo
index 63773ddac3..e0434e7ad4 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo
@@ -1,6 +1,13 @@
1class @beta Efl.Canvas.Animation_Group_Parallel extends Efl.Canvas.Animation_Group 1class @beta Efl.Canvas.Animation_Group_Parallel extends Efl.Canvas.Animation_Group
2{ 2{
3 [[Efl group parallel animation class]] 3 [[Combined animation which plays its individual animations in parallel
4 (all of them simultaneously).
5
6 For instance, this could be used to move an @Efl.Canvas.Object from one position to another
7 while rotating it along the way.
8
9 Use @Efl.Canvas.Animation_Group.animation_add to append individual animations.
10 ]]
4 c_prefix: efl_animation_group_parallel; 11 c_prefix: efl_animation_group_parallel;
5 data: null; 12 data: null;
6 methods { 13 methods {
diff --git a/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo b/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo
index 415a87f999..aebd70ede5 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo
@@ -1,6 +1,14 @@
1class @beta Efl.Canvas.Animation_Group_Sequential extends Efl.Canvas.Animation_Group 1class @beta Efl.Canvas.Animation_Group_Sequential extends Efl.Canvas.Animation_Group
2{ 2{
3 [[Efl group sequential animation class]] 3 [[Combined animation which plays its individual animations in a sequential order
4 (one after the other).
5
6 For instance, this could be used to move an @Efl.Canvas.Object from one position to another
7 and then start rotating it once it reaches its destination.
8
9 Use @Efl.Canvas.Animation_Group.animation_add to append individual animations.
10 Animations are played in the order in which they are added.
11 ]]
4 data: null; 12 data: null;
5 methods { 13 methods {
6 } 14 }