efl/interface : Documentation added for shape and gradient interface

Change-Id: Idd0c4abe675fa4723dc0309c3244e670968e485e

diff --git a/src/lib/efl/interfaces/efl_gfx_gradient.eo b/src/lib/efl/interfaces/efl_gfx_gradient.eo
index 3bd5bff..dae58e6 100644 (file)
--- a/src/lib/efl/interfaces/efl_gfx_gradient.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient.eo
@@ -4,23 +4,34 @@ interface Efl.Gfx.Gradient
    properties {
       stop {
          set {
-        }
-        get {
-        }
-        values {
-           const(Efl_Gfx_Gradient_Stop) *colors;
-           uint length;
-        }
+            /*@
+              Set the list of color stops for the gradient
+            */
+         }
+         get {
+            /*@
+              get the list of color stops.
+            */
+         }
+         values {
+            const(Efl_Gfx_Gradient_Stop) *colors; /*@ color stops list*/
+            uint length; /*@ length of the list */
+         }
       }
       spread {
          set {
-        }
-        get {
-        }
-        values {
-           Efl_Gfx_Gradient_Spread s;
-        }
+            /*@
+              Specifies the spread method that should be used for this gradient.
+            */
+         }
+         get {
+            /*@
+              Returns the spread method use by this gradient. The default is EFL_GFX_GRADIENT_SPREAD_PAD.
+            */
+         }
+         values {
+            Efl_Gfx_Gradient_Spread s; /*@ spread type to be used */
+         }
       }
    }
-
 }

diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
index 3b78aea..15a6ce0 100644 (file)
--- a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
@@ -4,22 +4,34 @@ interface Efl.Gfx.Gradient_Linear (Efl.Gfx.Gradient)
    properties {
       start {
          set {
+            /*@
+              Sets the start point of this linear gradient.
+            */
          }
          get {
+            /*@
+              Gets the start point of this linear gradient.
+            */
          }
          values {
-            double x;
-            double y;
+            double x; /*@ x co-ordinate of start point */
+            double y; /*@ y co-ordinate of start point */
          }
       }
       end {
          set {
+            /*@
+              Sets the end point of this linear gradient.
+            */
          }
          get {
+            /*@
+              Gets the end point of this linear gradient.
+            */
          }
          values {
-            double x;
-            double y;
+            double x; /*@ x co-ordinate of end point */
+            double y; /*@ y co-ordinate of end point */
          }
       }
    }

diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
index 50ae08f..5a84c78 100644 (file)
--- a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
@@ -4,31 +4,49 @@ interface Efl.Gfx.Gradient_Radial (Efl.Gfx.Gradient)
    properties {
       center {
          set {
+            /*@
+              Sets the center of this radial gradient.
+            */
          }
          get {
+            /*@
+              Gets the center of this radial gradient.
+            */
          }
          values {
-            double x;
-            double y;
+            double x; /*@ x co-ordinate of center point */
+            double y; /*@ y co-ordinate of center point */
          }
       }
       radius {
          set {
+            /*@
+              Sets the center radius of this radial gradient.
+            */
          }
          get {
+            /*@
+              Gets the center radius of this radial gradient.
+            */
          }
          values {
-            double r;
+            double r; /*@ center radius */
          }
       }
       focal {
          set {
+            /*@
+              Sets the focal point of this radial gradient.
+            */
          }
          get {
+            /*@
+              Gets the focal point of this radial gradient.
+            */
          }
          values {
-            double x;
-            double y;
+            double x; /*@ x co-ordinate of focal point */
+            double y; /*@ y co-ordinate of focal point */
          }
       }
    }

diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo b/src/lib/efl/interfaces/efl_gfx_shape.eo
index 6d3ab08..b45cf03 100644 (file)
--- a/src/lib/efl/interfaces/efl_gfx_shape.eo
+++ b/src/lib/efl/interfaces/efl_gfx_shape.eo
@@ -4,79 +4,137 @@ interface Efl.Gfx.Shape
    properties {
       stroke_scale {
          set {
+            /*@
+              Sets the stroke scale to be used for stroking the path.
+              the scale property will be used along with stroke width property.
+            */
          }
          get {
+            /*@
+              Get the stroke scalling factor used for stroking this path.
+            */
          }
          values {
-            double s;
+            double s; /*@ stroke scale value */
          }
       }
       stroke_color {
          set {
+            /*@
+              Sets the color to be used for stroking the path.
+            */
          }
          get {
+            /*@
+              Gets the color used for stroking the path.
+            */
          }
          values {
-            int r;
-            int g;
-            int b;
-            int a;
+            int r; /*@ The red component of the given color. */
+            int g; /*@ The green component of the given color. */
+            int b; /*@ The blue component of the given color. */
+            int a; /*@ The alpha component of the given color. */
          }
       }
       stroke_width {
          set {
+            /*@
+              Sets the stroke width to be used for stroking the path.
+            */
          }
          get {
+            /*@
+              Gets the stroke width to be used for stroking the path.
+            */
          }
          values {
-            double w;
+            double w; /*@ stroke width to be used */
          }
       }
       stroke_location {
          set {
+            /*@
+              
+            */
          }
          get {
+            /*@
+              
+            */
          }
          values {
-            double centered;
+            double centered; /*@  */
          }
       }
       stroke_dash {
          set {
+            /*@
+              
+            */
          }
          get {
+            /*@
+              
+            */
          }
          values {
-            const(Efl_Gfx_Dash) *dash;
-            uint length;
+            const(Efl_Gfx_Dash) *dash; /*@  */
+            uint length; /*@  */
          }
       }
       stroke_cap {
          set {
+            /*@
+              Sets the cap style to be used for stroking the path.
+              The cap will be used for capping the end point of a 
+              open subpath.
+
+              @see Efl_Gfx_Cap
+            */
          }
          get {
+            /*@
+              Gets the cap style used for stroking path.
+            */
          }
          values {
-            Efl_Gfx_Cap c;
+            Efl_Gfx_Cap c; /*@ cap style to use , default is EFL_GFX_CAP_BUTT */
          }
       }
       stroke_join {
          set {
+            /*@
+              Sets the join style to be used for stroking the path.
+              The join style will be used for joining the two line segment while stroking teh path.
+
+              @see Efl_Gfx_Join
+            */
          }
          get {
+            /*@
+              Gets the join style used for stroking path.
+            */
          }
          values {
-            Efl_Gfx_Join j;
+            Efl_Gfx_Join j; /*@ join style to use , default is EFL_GFX_JOIN_MITER */
          }
       }
       path {
          set {
+            /*@
+              Set the list of commands and points to be used to create the content of shape.
+
+              @note see efl_gfx_path interface for how to create a command list.
+            */
          }
          get {
+            /*@
+             Gets the command and points list 
+            */
          }
          values {
-            const(Efl_Gfx_Path_Command) *op;
-            const(double) *points;
+            const(Efl_Gfx_Path_Command) *op; /*@ command list */
+            const(double) *points; /*@ point list */
          }
       }
    }