evas_vg: refined the documentation for evas vector APIs

Summary: Depends on D11517

Reviewers: jsuya, Hermet

Reviewed By: jsuya

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D11518

src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h

@@ -15,23 +15,23 @@ typedef Eo Evas_Vg_Container;
 #endif
 
 /**
- * @brief Get child of container
+ * @brief Get child of container.
  *
  * @param[in] obj The object.
- * @param[in] name Child node name
+ * @param[in] name The Child node name.
  *
- * @return Child object
+ * @return The child object.
  *
  * @ingroup Evas_Vg_Container_Group
  */
 EAPI Evas_Vg_Node *evas_vg_container_child_get(Evas_Vg_Container *obj, const char *name);
 
 /**
- * @brief Get all children of container
+ * @brief Get all children of container.
  *
  * @param[in] obj The object.
  *
- * @return Iterator to children
+ * @return The iterator to children.
  *
  * @ingroup Evas_Vg_Container_Group
  */

src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h

@@ -20,7 +20,7 @@ typedef Eo Evas_Vg_Node;
  * @note Pass @c null to cancel the applied transformation.
  *
  * @param[in] obj The object.
- * @param[in] m Transformation matrix.
+ * @param[in] m The transformation matrix.
  *
  * @since 1.14
  *
@@ -32,8 +32,7 @@ EAPI void evas_vg_node_transformation_set(Evas_Vg_Node *obj, const Eina_Matrix3
  * @brief Gets the transformation matrix used for this node object.
  *
  * @param[in] obj The object.
- *
+ * @return The transformation matrix.
- * @return Transformation matrix.
  *
  * @since 1.14
  *

src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h

@@ -4,7 +4,8 @@
 #ifndef _EVAS_OBJECT_VG_EO_LEGACY_TYPES
 #define _EVAS_OBJECT_VG_EO_LEGACY_TYPES
 
-/** Enumeration that defines how viewbox will be filled int the vg canvs's
+/**
+ * @brief Enumeration that defines how viewbox will be filled int the vg canvs's
  * viewport. default Fill_Mode is @c none
  *
  * @ingroup Evas_Object_Vg_Group
@@ -106,7 +107,7 @@ EAPI void evas_object_vg_viewbox_align_get(const Evas_Object *obj, double *align
  * It takes the ownership of the root node.
  *
  * @param[in] obj The object.
- * @param[in] root Root node(Efl_Canvas_Vg_Container) of the VG canvas.
+ * @param[in] root Root node(Evas_Vg_Container) of the VG canvas.
  *
  * @ingroup Evas_Object_Vg_Group
  */

src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h

@@ -14,42 +14,40 @@ typedef Eo Evas_Vg_Shape;
 #endif
 
 /**
- * @brief Fill of the shape object
+ * @brief Fill of the shape object.
  *
  * @param[in] obj The object.
- * @param[in] f Fill object
+ * @param[in] f The fill object.
  *
  * @ingroup Evas_Vg_Shape_Group
  */
 EAPI void evas_vg_shape_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
 
 /**
- * @brief Fill of the shape object
+ * @brief Fill of the shape object.
  *
  * @param[in] obj The object.
- *
+ * @return The fill object.
- * @return Fill object
  *
  * @ingroup Evas_Vg_Shape_Group
  */
 EAPI Evas_Vg_Node *evas_vg_shape_fill_get(const Evas_Vg_Shape *obj);
 
 /**
- * @brief Stroke fill of the shape object
+ * @brief Stroke fill of the shape object.
  *
  * @param[in] obj The object.
- * @param[in] f Stroke fill object
+ * @param[in] f The stroke fill object.
  *
  * @ingroup Evas_Vg_Shape_Group
  */
 EAPI void evas_vg_shape_stroke_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
 
 /**
- * @brief Stroke fill of the shape object
+ * @brief Stroke fill of the shape object.
  *
  * @param[in] obj The object.
- *
+ * @return The stroke fill object.
- * @return Stroke fill object
  *
  * @ingroup Evas_Vg_Shape_Group
  */
@@ -69,7 +67,6 @@ EAPI void evas_vg_shape_stroke_marker_set(Evas_Vg_Shape *obj, Evas_Vg_Node *m);
  * @brief Stroke marker of the shape object
  *
  * @param[in] obj The object.
- *
  * @return Stroke marker object
  *
  * @ingroup Evas_Vg_Shape_Group