efl : Documentation added for efl enums. 67/43267/1
authorSubhransu Sekhar Mohanty <sub.mohanty@samsung.com>
Wed, 4 Feb 2015 12:49:17 +0000 (21:49 +0900)
committerSubhransu Mohanty <sub.mohanty@samsung.com>
Wed, 8 Jul 2015 02:11:06 +0000 (11:11 +0900)
Change-Id: I7c69fca9962acf1daeac6cfa4b8d1e5391c21cfc

src/lib/efl/Efl.h

index 23f0681..37ab654 100644 (file)
@@ -46,10 +46,32 @@ extern "C"
 
 #endif
 /**
- * Path command enum.
+ * @enum:
+ *   Efl_Gfx_Path_Command
  *
+ * @description:
+ *   These values determine how the points are interpreted in 
+ *   a stream of ponts.
+ *
+ * @values:
+ *   EFL_GFX_PATH_COMMAND_TYPE_END ::
+ *     The end of stream , no more points to process.
+ *
+ *   EFL_GFX_PATH_COMMAND_TYPE_MOVE_TO ::
+ *     The next point is the start point of a sub path.
+ *
+ *   EFL_GFX_PATH_COMMAND_TYPE_LINE_TO ::
+ *     The next point is used to draw a line from current point.
+ *
+ *   EFL_GFX_PATH_COMMAND_TYPE_CUBIC_TO ::
+ *     The next three point is used to draw a cubic bezier curve
+ *     from current point.
+ *
+ *   EFL_GFX_PATH_COMMAND_TYPE_CLOSE ::
+ *     Close the curent subpath by drawing a line between current point 
+ *     and the first point of current subpath.
+ *     last point.
  * @since 1.13
- * @ingroup Efl_Gfx_Shape
  */
 typedef enum _Efl_Gfx_Path_Command
 {
@@ -73,7 +95,25 @@ struct _Efl_Gfx_Dash
 };
 
 /**
- * Type defining how a line end.
+ * @enum:
+ *   Efl_Gfx_Cap
+ *
+ * @description:
+ *   These values determine how the end of opened sub-paths are
+ *   rendered in a stroke.
+ *
+ * @values:
+ *   EFL_GFX_CAP_BUTT ::
+ *     The end of lines is rendered as a full stop on the last
+ *     point itself.
+ *
+ *   EFL_GFX_CAP_ROUND ::
+ *     The end of lines is rendered as a half-circle around the
+ *     last point.
+ *
+ *   EFL_GFX_CAP_SQUARE ::
+ *     The end of lines is rendered as a square around the
+ *     last point.
  * @since 1.13
  */
 typedef enum _Efl_Gfx_Cap
@@ -85,7 +125,31 @@ typedef enum _Efl_Gfx_Cap
 } Efl_Gfx_Cap;
 
 /**
- * Type defining how join between path are drawn.
+ * @enum:
+ *   Efl_Gfx_Join
+ *
+ * @description:
+ *   These values determine how two joining lines are rendered
+ *   in a stroker.
+ *
+ * @values:
+ *   EFL_GFX_JOIN_ROUND ::
+ *     Used to render rounded line joins.  Circular arcs are used
+ *     to join two lines smoothly.
+ *
+ *   EFL_GFX_JOIN_BEVEL ::
+ *     Used to render beveled line joins.  The outer corner of
+ *     the joined lines is filled by enclosing the triangular
+ *     region of the corner with a straight line between the
+ *     outer corners of each stroke.
+ *
+ *   EFL_GFX_JOIN_MITER ::
+ *     Used to render mitered line joins. The intersection of the
+ *     strokes is clipped at a line perpendicular to the bisector
+ *     of the angle between the strokes, at the distance from the
+ *     intersection of the segments equal to the product of the
+ *     miter limit value and the border radius.  This prevents
+ *     long spikes being created.
  * @since 1.13
  */
 typedef enum _Efl_Gfx_Join
@@ -111,7 +175,21 @@ struct _Efl_Gfx_Gradient_Stop
 };
 
 /**
- * Type defining how the gradient spread after its limit.
+ * @enum:
+ *   Efl_Gfx_Gradient_Spread
+ *
+ * @description:
+ *   Specifies how the area outside the gradient area should be filled.
+ *
+ * @values:
+ *   EFL_GFX_GRADIENT_SPREAD_PAD ::
+ *     The area is filled with the closest stop color. This is the default.
+ *
+ *   EFL_GFX_GRADIENT_SPREAD_REFLECT ::
+ *     The gradient is reflected outside the gradient area.
+ *
+ *   EFL_GFX_GRADIENT_SPREAD_REPEAT ::
+ *     The gradient is repeated outside the gradient area.
  * @since 1.13
  */
 typedef enum _Efl_Gfx_Gradient_Spread