fix parameter docs

This commit is contained in:
Recep Aslantas
2017-07-06 17:00:04 +03:00
parent abbb8de0e3
commit 71d731173a
7 changed files with 46 additions and 52 deletions

View File

@@ -338,7 +338,7 @@ glm_decompose_scalev(mat4 m, vec3 s) {
* @brief returns true if matrix is uniform scaled. This is helpful for * @brief returns true if matrix is uniform scaled. This is helpful for
* creating normal matrix. * creating normal matrix.
* *
* @param m[in] m * @param[in] m m
* *
* @return boolean * @return boolean
*/ */
@@ -357,7 +357,7 @@ glm_uniscaled(mat4 m) {
* *
* @param[in] m affine transform * @param[in] m affine transform
* @param[out] r rotation matrix * @param[out] r rotation matrix
* @param[out] r scale matrix * @param[out] s scale matrix
*/ */
CGLM_INLINE CGLM_INLINE
void void

View File

@@ -55,8 +55,8 @@ glm_euler_order(int newOrder[3]) {
/*! /*!
* @brief euler angles (in radian) using xyz sequence * @brief euler angles (in radian) using xyz sequence
* *
* @param[in] m affine transform * @param[in] m affine transform
* @param[out] v angles vector [x, y, z] * @param[out] dest angles vector [x, y, z]
*/ */
CGLM_INLINE CGLM_INLINE
void void

View File

@@ -325,8 +325,8 @@ glm_mat4_mulv3(mat4 m, vec3 v, vec3 dest) {
* *
* source matrix will not be transposed unless dest is m * source matrix will not be transposed unless dest is m
* *
* @param m[in] matrix * @param[in] m matrix
* @param dest[out] result * @param[out] dest result
*/ */
CGLM_INLINE CGLM_INLINE
void void
@@ -533,8 +533,8 @@ glm_mat4_swap_col(mat4 mat, int col1, int col2) {
* @brief swap two matrix rows * @brief swap two matrix rows
* *
* @param[in,out] mat matrix * @param[in,out] mat matrix
* @param[in] col1 col1 * @param[in] row1 row1
* @param[in] col2 col2 * @param[in] row2 row2
*/ */
CGLM_INLINE CGLM_INLINE
void void

View File

@@ -126,8 +126,8 @@ glm_mat3_mul(mat3 m1, mat3 m2, mat3 dest) {
* *
* source matrix will not be transposed unless dest is m * source matrix will not be transposed unless dest is m
* *
* @param m[in] matrix * @param[in] m matrix
* @param dest[out] result * @param[out] dest result
*/ */
CGLM_INLINE CGLM_INLINE
void void
@@ -265,8 +265,8 @@ glm_mat3_swap_col(mat3 mat, int col1, int col2) {
* @brief swap two matrix rows * @brief swap two matrix rows
* *
* @param[in,out] mat matrix * @param[in,out] mat matrix
* @param[in] col1 col1 * @param[in] row1 row1
* @param[in] col2 col2 * @param[in] row2 row2
*/ */
CGLM_INLINE CGLM_INLINE
void void

View File

@@ -23,7 +23,7 @@
/*! /*!
* @brief get sign of 32 bit integer as +1 or -1 * @brief get sign of 32 bit integer as +1 or -1
* *
* @param X integer value * @param val integer value
*/ */
CGLM_INLINE CGLM_INLINE
int int

View File

@@ -109,8 +109,8 @@ glm_vec4_broadcast(float val, vec4 d) {
/*! /*!
* @brief check if vector is equal to value (without epsilon) * @brief check if vector is equal to value (without epsilon)
* *
* @param v vector
* @param val value * @param val value
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool
@@ -121,8 +121,8 @@ glm_vec_eq(vec3 v, float val) {
/*! /*!
* @brief check if vector is equal to value (with epsilon) * @brief check if vector is equal to value (with epsilon)
* *
* @param v vector
* @param val value * @param val value
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool
@@ -135,8 +135,7 @@ glm_vec_eq_eps(vec4 v, float val) {
/*! /*!
* @brief check if vectors members are equal (without epsilon) * @brief check if vectors members are equal (without epsilon)
* *
* @param val value * @param v vector
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool
@@ -175,8 +174,8 @@ glm_vec_eqv_eps(vec3 v1, vec3 v2) {
/*! /*!
* @brief check if vector is equal to value (without epsilon) * @brief check if vector is equal to value (without epsilon)
* *
* @param v vector
* @param val value * @param val value
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool
@@ -190,8 +189,8 @@ glm_vec4_eq(vec4 v, float val) {
/*! /*!
* @brief check if vector is equal to value (with epsilon) * @brief check if vector is equal to value (with epsilon)
* *
* @param v vector
* @param val value * @param val value
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool
@@ -205,8 +204,7 @@ glm_vec4_eq_eps(vec4 v, float val) {
/*! /*!
* @brief check if vectors members are equal (without epsilon) * @brief check if vectors members are equal (without epsilon)
* *
* @param val value * @param v vector
* @param d dest
*/ */
CGLM_INLINE CGLM_INLINE
bool bool

View File

@@ -97,7 +97,7 @@ glm_vec4_copy3(vec4 a, vec3 dest) {
/*! /*!
* @brief copy all members of [a] to [dest] * @brief copy all members of [a] to [dest]
* *
* @param[in] a source * @param[in] v source
* @param[out] dest destination * @param[out] dest destination
*/ */
CGLM_INLINE CGLM_INLINE
@@ -116,8 +116,8 @@ glm_vec4_copy(vec4 v, vec4 dest) {
/*! /*!
* @brief vec3 dot product * @brief vec3 dot product
* *
* @param[in] a * @param[in] a vector1
* @param[in] b * @param[in] b vector2
* *
* @return dot product * @return dot product
*/ */
@@ -130,8 +130,8 @@ glm_vec_dot(vec3 a, vec3 b) {
/*! /*!
* @brief vec4 dot product * @brief vec4 dot product
* *
* @param[in] a * @param[in] a vector1
* @param[in] b * @param[in] b vector2
* *
* @return dot product * @return dot product
*/ */
@@ -164,7 +164,7 @@ glm_vec_cross(vec3 a, vec3 b, vec3 d) {
* sqrtf fuction twice but with this func we can avoid func call, maybe this is * sqrtf fuction twice but with this func we can avoid func call, maybe this is
* not good name for this func * not good name for this func
* *
* @param[in] vec vec * @param[in] v vector
* *
* @return norm * norm * @return norm * norm
*/ */
@@ -177,7 +177,7 @@ glm_vec_norm2(vec3 v) {
/*! /*!
* @brief norm (magnitude) of vec3 * @brief norm (magnitude) of vec3
* *
* @param[in] vec * @param[in] vec vector
* *
* @return norm * @return norm
*/ */
@@ -194,7 +194,7 @@ glm_vec_norm(vec3 vec) {
* sqrtf fuction twice but with this func we can avoid func call, maybe this is * sqrtf fuction twice but with this func we can avoid func call, maybe this is
* not good name for this func * not good name for this func
* *
* @param[in] vec vec4 * @param[in] v vec4
* *
* @return norm * norm * @return norm * norm
*/ */
@@ -207,7 +207,7 @@ glm_vec4_norm2(vec4 v) {
/*! /*!
* @brief norm (magnitude) of vec4 * @brief norm (magnitude) of vec4
* *
* @param[in] vec * @param[in] vec vector
* *
* @return norm * @return norm
*/ */
@@ -220,8 +220,8 @@ glm_vec4_norm(vec4 vec) {
/*! /*!
* @brief add v2 vector to v1 vector store result in dest * @brief add v2 vector to v1 vector store result in dest
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @param[out] dest destination vector * @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
@@ -235,8 +235,8 @@ glm_vec_add(vec3 v1, vec3 v2, vec3 dest) {
/*! /*!
* @brief add v2 vector to v1 vector store result in dest * @brief add v2 vector to v1 vector store result in dest
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @param[out] dest destination vector * @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
@@ -257,8 +257,8 @@ glm_vec4_add(vec4 v1, vec4 v2, vec4 dest) {
/*! /*!
* @brief subtract v2 vector from v1 vector store result in dest * @brief subtract v2 vector from v1 vector store result in dest
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @param[out] dest destination vector * @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
@@ -272,8 +272,8 @@ glm_vec_sub(vec3 v1, vec3 v2, vec3 dest) {
/*! /*!
* @brief subtract v2 vector from v1 vector store result in dest * @brief subtract v2 vector from v1 vector store result in dest
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @param[out] dest destination vector * @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
@@ -373,9 +373,7 @@ glm_vec4_scale_as(vec4 v, float s, vec4 dest) {
/*! /*!
* @brief flip sign of all vec3 members * @brief flip sign of all vec3 members
* *
* @param[in] v vector * @param[in, out] v vector
* @param[in] s scalar
* @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
void void
@@ -388,9 +386,7 @@ glm_vec_flipsign(vec3 v) {
/*! /*!
* @brief flip sign of all vec4 members * @brief flip sign of all vec4 members
* *
* @param[in] v vector * @param[in, out] v vector
* @param[in] s scalar
* @param[out] dest destination vector
*/ */
CGLM_INLINE CGLM_INLINE
void void
@@ -572,8 +568,8 @@ glm_vec_rotate_m4(mat4 m, vec3 v, vec3 dest) {
/*! /*!
* @brief project a vector onto b vector * @brief project a vector onto b vector
* *
* @param[in] a * @param[in] a vector1
* @param[in] b * @param[in] b vector2
* @param[out] dest projected vector * @param[out] dest projected vector
*/ */
CGLM_INLINE CGLM_INLINE
@@ -587,8 +583,8 @@ glm_vec_proj(vec3 a, vec3 b, vec3 dest) {
/** /**
* @brief find center point of two vector * @brief find center point of two vector
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @param[out] dest center point * @param[out] dest center point
*/ */
CGLM_INLINE CGLM_INLINE
@@ -601,8 +597,8 @@ glm_vec_center(vec3 v1, vec3 v2, vec3 dest) {
/** /**
* @brief distance between two vectors * @brief distance between two vectors
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @return returns distance * @return returns distance
*/ */
CGLM_INLINE CGLM_INLINE
@@ -616,8 +612,8 @@ glm_vec_distance(vec3 v1, vec3 v2) {
/** /**
* @brief distance between two vectors * @brief distance between two vectors
* *
* @param[in] v1 * @param[in] v1 vector1
* @param[in] v2 * @param[in] v2 vector2
* @return returns distance * @return returns distance
*/ */
CGLM_INLINE CGLM_INLINE