efl/vector: fill up missing docs.

Change-Id: Id560b18bf204278c2aa55ef5c8c09821bead5cd8

diff --git a/src/lib/efl/Efl.h b/src/lib/efl/Efl.h
index 4ec1ee64d6369d35cf3df82157751da165f2d559..55cb3c9e13c9702cec729db6c26cc1526811f042 100644 (file)
--- a/src/lib/efl/Efl.h
+++ b/src/lib/efl/Efl.h
@@ -119,16 +119,17 @@ typedef enum _Efl_Gfx_Join
 
 /**
  * Type defining gradient stop.
+ * @note Describe the location and color of a transition point in a gradient.
  * @since 1.14
  */
 typedef struct _Efl_Gfx_Gradient_Stop Efl_Gfx_Gradient_Stop;
 struct _Efl_Gfx_Gradient_Stop
 {
-   double offset;
-   int r;
-   int g;
-   int b;
-   int a;
+   double offset; /**< The location of the gradient stop within the gradient vector*/
+   int r; /**< The component R color of the gradient stop */
+   int g; /**< The component G color of the gradient stop */
+   int b; /**< The component B color of the graident stop */
+   int a; /**< The component A color of the graident stop */
 };
 
 /**

diff --git a/src/lib/efl/interfaces/efl_gfx_utils.h b/src/lib/efl/interfaces/efl_gfx_utils.h
index 184b1402b28898d74046325c3b9db56e27142dd4..1083c5724ceca7bf918bce68640d43f09406fadf 100644 (file)
--- a/src/lib/efl/interfaces/efl_gfx_utils.h
+++ b/src/lib/efl/interfaces/efl_gfx_utils.h
@@ -1,6 +1,19 @@
 #ifndef EFL_GRAPHICS_UTILS_H_
 # define EFL_GRAPHICS_UTILS_H_
 
+/**
+ * Copy Path Command List and Point's List
+ *
+ * @param out_cmd copied command list to be returned
+ * @param out_pts copied point's list to be returned
+ * @param in_cmd source command list
+ * @param in_pts source point's list
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on error.
+ *
+ * @warning @p out_cmd and @p out_pts should be passed with NULL pointers.
+ *
+ * @since 1.14
+ */
 EAPI Eina_Bool
 efl_gfx_path_dup(Efl_Gfx_Path_Command **out_cmd, double **out_pts,
                  const Efl_Gfx_Path_Command *in_cmd, const double *in_pts);
@@ -239,10 +252,34 @@ efl_gfx_path_interpolate(const Efl_Gfx_Path_Command *cmd,
                          double pos_map,
                          const double *from, const double *to, double *r);
 
+/**
+ * Compare two path commands whether both command lists are same or not.
+ *
+ * @param a command list
+ * @param b command list
+ * @return @c EINA_TRUE if @p a and @p b command list are same, @c EINA_FALSE,
+ *         otherwise.
+ *
+ * @since 1.14
+ */
 EAPI Eina_Bool
 efl_gfx_path_equal_commands(const Efl_Gfx_Path_Command *a,
                             const Efl_Gfx_Path_Command *b);
 
+/**
+ * Return the current(last) path and control position.
+ *
+ * @param cmd command list
+ * @param points point's list
+ * @param current_x current x position
+ * @param current_y current y position
+ * @param current_ctrl_x current x control point (just in case CUBIC type)
+ * @param current_ctrl_y current y control point (just in case CUBIC type)
+ * @return @c EINA_TRUE on success or @c EINA_FALSE if there are no positions to
+ *         be returned.
+ *
+ * @since 1.14
+ */
 EAPI Eina_Bool
 efl_gfx_path_current_get(const Efl_Gfx_Path_Command *cmd,
                          const double *points,