summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-31 15:16:39 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-31 15:16:53 -0400
commit28d359b00c130038966afa1f6f1c5b45f2ff871f (patch)
treea28bfc605d512a33289b6c7237f9422af9747232 /src/lib/eina
parent8f352dedd05f03ea5e58468caaf8ecf237b5adf0 (diff)
eina: Add doxygen in/out tags for quaternion
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6708
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_quaternion.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/src/lib/eina/eina_quaternion.h b/src/lib/eina/eina_quaternion.h
index dc08acf997..3de9996d05 100644
--- a/src/lib/eina/eina_quaternion.h
+++ b/src/lib/eina/eina_quaternion.h
@@ -144,8 +144,8 @@ EAPI void eina_quaternion_matrix4_to(Eina_Matrix4 *m,
144/** 144/**
145 * @brief Compute the inverse of the given quaternion. 145 * @brief Compute the inverse of the given quaternion.
146 * 146 *
147 * @param out The quaternion to invert. 147 * @param[out] out The quaternion to invert.
148 * @param q The quaternion matrix. 148 * @param[in] q The quaternion matrix.
149 * 149 *
150 * This function inverses the quaternion @p q and stores the result in 150 * This function inverses the quaternion @p q and stores the result in
151 * @p out. 151 * @p out.
@@ -157,8 +157,8 @@ EAPI void eina_quaternion_inverse(Eina_Quaternion *out, const Eina_Quaternion *q
157/** 157/**
158 * @brief Set array to quaternion. 158 * @brief Set array to quaternion.
159 * 159 *
160 * @param dst The result quaternion 160 * @param[out] dst The result quaternion
161 * @param v The the array[4] for set 161 * @param[in] v The the array[4] for set
162 * 162 *
163 * Set to quaternion first 4 elements from array 163 * Set to quaternion first 4 elements from array
164 * 164 *
@@ -169,8 +169,8 @@ EAPI void eina_quaternion_array_set(Eina_Quaternion *dst, const double *v);
169/** 169/**
170 * @brief Copy quaternion. 170 * @brief Copy quaternion.
171 * 171 *
172 * @param dst The quaternion copy 172 * @param[out] dst The quaternion copy
173 * @param src The quaternion for copy. 173 * @param[in] src The quaternion for copy.
174 * 174 *
175 * @since 1.17 175 * @since 1.17
176 */ 176 */
@@ -180,8 +180,8 @@ EAPI void eina_quaternion_copy(Eina_Quaternion *dst,
180/** 180/**
181 * @brief Homogeneous quaternion 181 * @brief Homogeneous quaternion
182 * 182 *
183 * @param out The resulting quaternion 183 * @param[out] out The resulting quaternion
184 * @param v The given quaternion 184 * @param[in] v The given quaternion
185 * 185 *
186 * @since 1.17 186 * @since 1.17
187 */ 187 */
@@ -191,9 +191,9 @@ EAPI void eina_quaternion_homogeneous_regulate(Eina_Quaternion *out,
191/** 191/**
192 * @brief Subtract two quaternions 192 * @brief Subtract two quaternions
193 * 193 *
194 * @param out The resulting quaternion 194 * @param[out] out The resulting quaternion
195 * @param a The first member of the subtract 195 * @param[in] a The first member of the subtract
196 * @param b The second member of the subtract 196 * @param[in] b The second member of the subtract
197 * 197 *
198 * @since 1.17 198 * @since 1.17
199 */ 199 */
@@ -203,7 +203,7 @@ EAPI void eina_quaternion_subtract(Eina_Quaternion *out, const Eina_Quaternion *
203/** 203/**
204 * @brief Return the length of the given quaternion. 204 * @brief Return the length of the given quaternion.
205 * 205 *
206 * @param v The quaternion. 206 * @param[out] v The quaternion.
207 * @return The length. 207 * @return The length.
208 * 208 *
209 * @since 1.17 209 * @since 1.17
@@ -213,7 +213,7 @@ EAPI double eina_quaternion_length_get(const Eina_Quaternion *v);
213/** 213/**
214 * @brief Return the length in square of the given quaternion. 214 * @brief Return the length in square of the given quaternion.
215 * 215 *
216 * @param v The quaternion. 216 * @param[out] v The quaternion.
217 * @return The length in square. 217 * @return The length in square.
218 * 218 *
219 * @since 1.17 219 * @since 1.17
@@ -223,8 +223,8 @@ EAPI double eina_quaternion_length_square_get(const Eina_Quaternion *v);
223/** 223/**
224 * @brief Return the distance between of two quaternions. 224 * @brief Return the distance between of two quaternions.
225 * 225 *
226 * @param a The first quaternion. 226 * @param[in] a The first quaternion.
227 * @param b The second quaternion. 227 * @param[in] b The second quaternion.
228 * @return The distance. 228 * @return The distance.
229 * 229 *
230 * @since 1.17 230 * @since 1.17
@@ -234,8 +234,8 @@ EAPI double eina_quaternion_distance_get(const Eina_Quaternion *a,
234/** 234/**
235 * @brief Return the distance in square between of two quaternions. 235 * @brief Return the distance in square between of two quaternions.
236 * 236 *
237 * @param a The first quaternion. 237 * @param[in] a The first quaternion.
238 * @param b The second quaternion. 238 * @param[in] b The second quaternion.
239 * @return The distance in square. 239 * @return The distance in square.
240 * 240 *
241 * @since 1.17 241 * @since 1.17
@@ -246,9 +246,9 @@ EAPI double eina_quaternion_distance_square_get(const Eina_Quaternion *a,
246/** 246/**
247 * @brief Transform quaternion. 247 * @brief Transform quaternion.
248 * 248 *
249 * @param out The result quaternion. 249 * @param[out] out The result quaternion.
250 * @param v The quaternion for transform. 250 * @param[in] v The quaternion for transform.
251 * @param m The matrix for transform. 251 * @param[in] m The matrix for transform.
252 * 252 *
253 * @since 1.17 253 * @since 1.17
254 */ 254 */
@@ -258,8 +258,8 @@ EAPI void eina_quaternion_transform(Eina_Quaternion *out, const Eina_Quaternion
258/** 258/**
259 * @brief Return the angle plains between of two quaternions. 259 * @brief Return the angle plains between of two quaternions.
260 * 260 *
261 * @param a The first quaternion. 261 * @param[in] a The first quaternion.
262 * @param b The second quaternion. 262 * @param[in] b The second quaternion.
263 * @return The angle. 263 * @return The angle.
264 * 264 *
265 * @since 1.17 265 * @since 1.17