evas: add documentation for Evas_Object_Vg class.
authorSubhransu Sekhar Mohanty <sub.mohanty@samsung.com>
Fri, 3 Apr 2015 14:30:38 +0000 (16:30 +0200)
committerCedric BAIL <cedric@osg.samsung.com>
Fri, 3 Apr 2015 14:30:38 +0000 (16:30 +0200)
src/lib/evas/canvas/evas_vg.eo
src/lib/evas/canvas/evas_vg_node.eo

index 97e38c53b35acc9fa132c614d8cb9281e778d901..f7e91c394c1bc6dd45d07d0878ff2766ea60df68 100644 (file)
@@ -4,13 +4,21 @@ class Evas.VG (Evas.Object, Efl.File, Efl.Gfx.Fill, Efl.Gfx.View)
    eo_prefix: evas_obj_vg;
    properties {
       root_node {
-        get {
-        }
-        values {
-           Evas_VG_Node *container;
-        }
+         get {
+            /*@
+              Get the root node of the evas_object_vg.
+
+              @note To manually create the shape object and show in the Vg
+                    object canvas you must create the hirarchy and set the
+                    parent as root node.
+              @since 1.14
+            */
+         }
+         values {
+            Evas_VG_Node *container; /*@ Root node of the VG canvas */
+         }
       }
-  }
+   }
    implements {
       Eo.Base.constructor;
       Efl.File.file.set;
index e388442318786cc7fa7358615cd6653f0141f75a..83c7014ae158bb1b95a4e07c28e2d7e9be9cf54c 100644 (file)
@@ -5,22 +5,39 @@ abstract Evas.VG_Node (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack)
    properties {
       transformation {
          set {
-        }
-        get {
-        }
-        values {
-           const(Eina_Matrix3) *m;
-        }
+            /*@
+             Sets the transformation matrix to be used for this node object.
+             @since 1.14
+            */
+         }
+         get {
+            /*@
+             Gets the transformation matrix used for this node object.
+             @since 1.14
+            */
+         }
+         values {
+            const(Eina_Matrix3) *m; /*@ transformation matrix */
+         }
       }
       origin {
          set {
-        }
-        get {
-        }
-        values {
-           double x;
-           double y;
-        }
+            /*@
+             Sets the origin position of this node object. This origin position
+             affects to node transformation
+             @since 1.14
+            */
+         }
+         get {
+            /*@
+             Gets the origin position of this node object.
+             @since 1.14
+            */
+         }
+         values {
+            double x; /* @origin x position */
+            double y; /* @origin y position */
+         }
       }
       mask {
          set {
@@ -43,25 +60,27 @@ abstract Evas.VG_Node (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack)
    }
    methods {
       bound_get {
-        /*@
-        Give the bounding box in screen coordinate as being drawn.
-        It will start as the control box until it is refined once
-        the shape is computed.
-       */
+         /*@
+          Give the bounding box in screen coordinate as being drawn.
+          It will start as the control box until it is refined once the shape
+          is computed.
+          @since 1.14
+         */
          return: bool @warn_unused;
-        params {
-           @out Eina_Rectangle r;
-        }
+         params {
+            @out Eina_Rectangle r; /*@ bounding box to be returned */
+         }
       }
       original_bound_get {
-        /*@
-        Give the bounding box in screen coordinate as defined in
-        the file or at the insertion of the object (before any scaling).
-       */
+         /*@
+          Give the bounding box in screen coordinate as defined in
+          the file or at the insertion of the object (before any scaling).
+          @since 1.14
+         */
          return: bool @warn_unused;
-        params {
-           @out Eina_Rectangle r;
-        }
+         params {
+            @out Eina_Rectangle r; /*@ original bounding box to be returned */
+         }
       }
    }
    implements {