[EGIT] [core/efl] master 01/01: efl_canvas_animation_player: improve docs

[Marcel Hollerbach]

xartigas pushed a commit to branch master.

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

commit f324e9fc1155489444e775461fa8db7ebc300c42
Author: Marcel Hollerbach <m...@marcel-hollerbach.de>
Date:   Mon Sep 30 17:03:01 2019 +0200

    efl_canvas_animation_player: improve docs
    
    Reviewers: segfaultxavi
    
    Reviewed By: segfaultxavi
    
    Subscribers: cedric, #reviewers, #committers
    
    Tags: #efl
    
    Differential Revision: https://phab.enlightenment.org/D10250
---
 src/lib/evas/canvas/efl_canvas_animation_player.eo | 26 +++++++++++++---------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/src/lib/evas/canvas/efl_canvas_animation_player.eo 
b/src/lib/evas/canvas/efl_canvas_animation_player.eo
index 361dfcbad5..9a391cb874 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_player.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_player.eo
@@ -1,13 +1,19 @@
 class @beta Efl.Canvas.Animation_Player extends Efl.Object implements 
Efl.Player, Efl.Playable
 {
-   [[Efl animation object class]]
+   [[Player object for playing canvas animations.
+
+     This player object can be used to play animations on a @.target canvas 
object.
+     The type of animation depends on the @.animation object.
+   ]]
    c_prefix: efl_animation_player;
    methods {
       @property animation {
-         set {}
-         get {}
+         [[The animation to play.
+
+           This animation object will be used to change the visual state of 
the @.target object.
+         ]]
          values {
-            animation: Efl.Canvas.Animation;
+            animation: Efl.Canvas.Animation; [[An already-configured animation 
object.]]
          }
       }
       @property auto_del {
@@ -22,13 +28,13 @@ class @beta Efl.Canvas.Animation_Player extends Efl.Object 
implements Efl.Player
          }
       }
       @property target {
-         [[Target object property]]
-         set {
-         }
-         get {
-         }
+         [[The canvas object to apply the effects of the @.animation object on.
+
+           The @.animation object can change several properties of the $target.
+           You should ensure that nothing else is trying to change them too.
+         ]]
          values {
-            target: Efl.Canvas.Object; [[Target object which is applied 
animation.]]
+            target: Efl.Canvas.Object; [[Canvas object to animate.]]
          }
       }
    }

--