eina: add missing documentation for quad.

Summary: This adds missing doxgen documentation for eina_quad.

Test Plan: API Doxygen Revision

Reviewers: cedric, jpeg, myoungwoon

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

Change-Id: Ic75927dad1e9e5efaec7f43a39840ef6b13a53bd
Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>

diff --git a/src/lib/eina/eina_quad.h b/src/lib/eina/eina_quad.h
index e03f63e..c47ecbf 100644 (file)
--- a/src/lib/eina/eina_quad.h
+++ b/src/lib/eina/eina_quad.h
@@ -55,6 +55,11 @@ typedef struct _Eina_Quad
 } Eina_Quad;
 
 /**
+ * @brief Transform the given quadrangle to the given rectangle.
+ *
+ * @param q The quadrangle to get coordinates.
+ * @param r The rectangle.
+ *
  * @since 1.14
  *
  * @if MOBILE @since_tizen 3.0
@@ -64,6 +69,11 @@ typedef struct _Eina_Quad
 EAPI void eina_quad_rectangle_to(const Eina_Quad *q,
                                  Eina_Rectangle *r);
 /**
+ * @brief Transform the given rectangle to the given quadrangle.
+ *
+ * @param q The quadrangle.
+ * @param r The rectangle to get coordinates.
+ *
  * @since 1.14
  *
  * @if MOBILE @since_tizen 3.0
@@ -73,6 +83,18 @@ EAPI void eina_quad_rectangle_to(const Eina_Quad *q,
 EAPI void eina_quad_rectangle_from(Eina_Quad *q,
                                    const Eina_Rectangle *r);
 /**
+ * @brief Sets the values of the coordinates of the given quadrangle.
+ *
+ * @param q The quadrangle to set coordinates.
+ * @param x0 Top left x coordinate.
+ * @param y0 Top left y coordinate.
+ * @param x1 Top right x coordinate.
+ * @param y1 Top right y coordinate.
+ * @param x2 Bottom right x coordinate.
+ * @param y2 Bottom right y coordinate.
+ * @param x3 Bottom left x coordinate.
+ * @param y3 Bottom left y coordinate.
+ *
  * @since 1.14
  *
  * @if MOBILE @since_tizen 3.0
@@ -80,12 +102,24 @@ EAPI void eina_quad_rectangle_from(Eina_Quad *q,
  * @endif
  * */
 EAPI void eina_quad_coords_set(Eina_Quad *q,
+                               double x0, double y0,
                                double x1, double y1,
                                double x2, double y2,
-                               double x3, double y3,
-                               double x4, double y4);
+                               double x3, double y3);
 
 /**
+ * @brief Gets the values of the coordinates of the given quadrangle.
+ *
+ * @param q The quadrangle to get coordinates.
+ * @param x0 Top left x coordinate.
+ * @param y0 Top left y coordinate.
+ * @param x1 Top right x coordinate.
+ * @param y1 Top right y coordinate.
+ * @param x2 Bottom right x coordinate.
+ * @param y2 Bottom right y coordinate.
+ * @param x3 Bottom left x coordinate.
+ * @param y3 Bottom left y coordinate.
+ *
  * @since 1.14
  *
  * @if MOBILE @since_tizen 3.0
@@ -93,10 +127,10 @@ EAPI void eina_quad_coords_set(Eina_Quad *q,
  * @endif
  * */
 EAPI void eina_quad_coords_get(const Eina_Quad *q,
+                               double *x0, double *y0,
                                double *x1, double *y1,
                                double *x2, double *y2,
-                               double *x3, double *y3,
-                               double *x4, double *y4);
+                               double *x3, double *y3);
 
 /**
  * @}