YourWishes/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-02-17 03:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix some doc typos & warnings

Browse Source
This commit is contained in:
Recep Aslantas
2023-12-30 23:11:15 +03:00
parent 3a2a26e5a4
commit 015e859075
5 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/cglm/aabb2d.h
View File

@@ -86,8 +86,8 @@ glm_aabb2d_merge(vec2 aabb1[2], vec2 aabb2[2], vec2 dest[2]) {
* aabb * aabb
* *
* @param[in] aabb bounding aabb 1 * @param[in] aabb bounding aabb 1
* @param[in] cropaabb crop aabb * @param[in] cropAabb crop aabb
* @param[out] dest cropped bounding aabb * @param[out] dest cropped bounding aabb
*/ */
CGLM_INLINE CGLM_INLINE
void void
@@ -107,16 +107,16 @@ glm_aabb2d_crop(vec2 aabb[2], vec2 cropAabb[2], vec2 dest[2]) {
* aabb * aabb
* *
* @param[in] aabb bounding aabb * @param[in] aabb bounding aabb
* @param[in] cropaabb crop aabb * @param[in] cropAabb crop aabb
* @param[in] clampaabb miniumum aabb * @param[in] clampAabb miniumum aabb
* @param[out] dest cropped bounding aabb * @param[out] dest cropped bounding aabb
*/ */
CGLM_INLINE CGLM_INLINE
void void
glm_aabb2d_crop_until(vec2 aabb[2], glm_aabb2d_crop_until(vec2 aabb[2],
vec2 cropAabb[2], vec2 cropAabb[2],
vec2 clampAabb[2], vec2 clampAabb[2],
vec2 dest[2]) { vec2 dest[2]) {
glm_aabb2d_crop(aabb, cropAabb, dest); glm_aabb2d_crop(aabb, cropAabb, dest);
glm_aabb2d_merge(clampAabb, dest, dest); glm_aabb2d_merge(clampAabb, dest, dest);
} }

4
include/cglm/ivec2.h
View File

@@ -360,7 +360,7 @@ glm_ivec2_subsubs(ivec2 a, int s, ivec2 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a + b) * @param[out] dest dest -= (a + b)
*/ */
CGLM_INLINE CGLM_INLINE
@@ -392,7 +392,7 @@ glm_ivec2_addsubs(ivec2 a, int s, ivec2 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a * b) * @param[out] dest dest -= (a * b)
*/ */
CGLM_INLINE CGLM_INLINE

4
include/cglm/ivec3.h
View File

@@ -378,7 +378,7 @@ glm_ivec3_subsubs(ivec3 a, int s, ivec3 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a + b) * @param[out] dest dest -= (a + b)
*/ */
CGLM_INLINE CGLM_INLINE
@@ -412,7 +412,7 @@ glm_ivec3_addsubs(ivec3 a, int s, ivec3 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a * b) * @param[out] dest dest -= (a * b)
*/ */
CGLM_INLINE CGLM_INLINE

4
include/cglm/ivec4.h
View File

@@ -394,7 +394,7 @@ glm_ivec4_subsubs(ivec4 a, int s, ivec4 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a + b) * @param[out] dest dest -= (a + b)
*/ */
CGLM_INLINE CGLM_INLINE
@@ -430,7 +430,7 @@ glm_ivec4_addsubs(ivec4 a, int s, ivec4 dest) {
* applies -= operator so dest must be initialized * applies -= operator so dest must be initialized
* *
* @param[in] a vector * @param[in] a vector
* @param[in] s scalar * @param[in] b scalar
* @param[out] dest dest -= (a * b) * @param[out] dest dest -= (a * b)
*/ */
CGLM_INLINE CGLM_INLINE

12
include/cglm/struct/euler.h
View File

@@ -160,7 +160,7 @@ glms_euler_by_order(vec3s angles, glm_euler_seq ord) {
* rotations in x y z order (roll pitch yaw) * rotations in x y z order (roll pitch yaw)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors
@@ -175,7 +175,7 @@ glms_euler_xyz_quat(vec3s angles) {
* rotations in x z y order (roll yaw pitch) * rotations in x z y order (roll yaw pitch)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors
@@ -190,7 +190,7 @@ glms_euler_xzy_quat(vec3s angles) {
* rotations in y x z order (pitch roll yaw) * rotations in y x z order (pitch roll yaw)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors
@@ -205,7 +205,7 @@ glms_euler_yxz_quat(vec3s angles) {
* rotations in y z x order (pitch yaw roll) * rotations in y z x order (pitch yaw roll)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors
@@ -220,7 +220,7 @@ glms_euler_yzx_quat(vec3s angles) {
* rotations in z x y order (yaw roll pitch) * rotations in z x y order (yaw roll pitch)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors
@@ -235,7 +235,7 @@ glms_euler_zxy_quat(vec3s angles) {
* rotations in z y x order (yaw pitch roll) * rotations in z y x order (yaw pitch roll)
* *
* @param[in] angles angles x y z (radians) * @param[in] angles angles x y z (radians)
* @param[out] dest quaternion * @returns quaternion
*/ */
CGLM_INLINE CGLM_INLINE
versors versors