From: Bowon Ryu <bowon.ryu@samsung.com>
Date: Tue, 17 Oct 2017 04:14:39 +0000 (+0900)
Subject: eina: rename parameter for doxygen
X-Git-Tag: accepted/tizen/unified/20171025.075203~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F30%2F156030%2F2;p=platform%2Fupstream%2Fefl.git

eina: rename parameter for doxygen

Summary:
Some parameter's name are different in annotations and statements,
so it occurs doxygen warning.
To fix it, rename that parameters.

Test Plan: API Doxygen Revision

Reviewers: raster, cedric, jpeg, myoungwoon, Jaehyun_Cho

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

Change-Id: Idd3f6f9ab4dc2aedd14735dfa4bfaacb3d863bc8
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
---

diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h
index fbe30d5..29ec3dc 100644
--- a/src/lib/eina/eina_matrix.h
+++ b/src/lib/eina/eina_matrix.h
@@ -182,6 +182,18 @@ struct _Eina_Matrix3_F16p16
 EAPI void eina_matrix3_f16p16_identity(Eina_Matrix3_F16p16 *m);
 
 /**
+ * @brief Sets dst as the matrix multiplication (composition) of two
+ * Eina_F16p16 matrices.
+ *
+ * In matrix multiplication, AB, the resultant matrix is created from
+ * the rows of A multiplied against the columns of B and summed.  This
+ * is not a cummutative; i.e.  AB != BA, so the ordering of arguments
+ * @p m1 and @p m2 matters.
+ *
+ * @param[in] m1 The first matrix.  Must be non-NULL.
+ * @param[in] m2 The second matrix.  Must be non-NULL.
+ * @param[out] dst The matrix for the results to be placed.
+ *
  * @since 1.14
  *
  * @if MOBILE @since_tizen 3.0
@@ -964,7 +976,7 @@ EAPI void eina_matrix4_multiply(Eina_Matrix4 *out, const Eina_Matrix4 *mat_a,
  * @param left The left value
  * @param bottom The bottom value
  * @param top The top value
- * @param dneat The dnear value
+ * @param dnear The dnear value
  * @param dfar The dfar value
  *
  * @since 1.17
@@ -1059,12 +1071,12 @@ EAPI void eina_matrix2_values_get(const Eina_Matrix2 *m, double *xx, double *xy,
 /**
  * @brief Computes the inverse with check of the given matrix.
  *
- * @param m The matrix to inverse.
- * @param m2 The inverse matrix.
+ * @param out The matrix to inverse.
+ * @param mat The inverse matrix.
  *
- * This function inverse the matrix @p m and stores the result in
- * @p m2. No check is done on @p m or @p m2. If @p m can not be
- * invertible, then @p m2 is set to the identity matrix.
+ * This function inverse the matrix @p out and stores the result in
+ * @p mat. No check is done on @p out or @p mat. If @p out can not be
+ * invertible, then @p mat is set to the identity matrix.
  *
  * @since 1.17
  *
@@ -1124,8 +1136,8 @@ EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src);
  * @brief Multiplies two matrix.
  *
  * @param out The resulting matrix
- * @param a The first member of the multiplication
- * @param b The second member of the multiplication
+ * @param mat_a The first member of the multiplication
+ * @param mat_b The second member of the multiplication
  *
  * @since 1.17
  *
@@ -1140,8 +1152,8 @@ EAPI void eina_matrix2_multiply(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a,
  * @brief Multiplies two matrix with check.
  *
  * @param out The resulting matrix
- * @param a The first member of the multiplication
- * @param b The second member of the multiplication
+ * @param mat_a The first member of the multiplication
+ * @param mat_b The second member of the multiplication
  *
  * @since 1.17
  *