Skip to content

Commit

Permalink
Merge pull request #423 from waywardmonkeys/reduce-typo-count
Browse files Browse the repository at this point in the history
Reduce typo count.
  • Loading branch information
recp authored Jul 15, 2024
2 parents ed731f9 + 068f695 commit d491108
Show file tree
Hide file tree
Showing 15 changed files with 26 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/source/aabb2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Functions documentation
| crops a bounding box with another one.
this could be useful for gettng a bbox which fits with view frustum and
this could be useful for getting a bbox which fits with view frustum and
object bounding boxes. In this case you crop view frustum box with objects
box
Expand All @@ -95,7 +95,7 @@ Functions documentation
| crops a bounding box with another one.
this could be useful for gettng a bbox which fits with view frustum and
this could be useful for getting a bbox which fits with view frustum and
object bounding boxes. In this case you crop view frustum box with objects
box
Expand Down
2 changes: 1 addition & 1 deletion docs/source/affine-pre.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Functions documentation
If you need to rotate object around itself e.g. center of object or at
some point [of object] then `glm_rotate_at()` would be better choice to do so.
Even if object's model transform is identiy, rotation may not be around
Even if object's model transform is identity, rotation may not be around
center of object if object does not lay out at ORIGIN perfectly.
Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api_struct.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ By default struct api adds `s` suffix to every type name e.g. vec3s, mat4s, vers
Also struct api `s` suffix to namespace e.g. `glms_vec3_add`, `glms_mat4_mul` etc.

By starting v0.9.0, struct api namespace is configurable. We can omit **glms_** namespace or
even change it with custom name to move existing api integrations to **cglm** more easliy...
even change it with custom name to move existing api integrations to **cglm** more easily...
We can also add **s** to function names if we want e.g. `glms_vec3_add()` -> `vec3_add()` or `vec3s_add()`.

By including **cglm/struct.h** header you will include all struct api. It will also include **cglm/cglm.h** too.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Functions documentation
| crops a bounding box with another one.
this could be useful for gettng a bbox which fits with view frustum and
this could be useful for getting a bbox which fits with view frustum and
object bounding boxes. In this case you crop view frustum box with objects
box
Expand All @@ -75,7 +75,7 @@ Functions documentation
| crops a bounding box with another one.
this could be useful for gettng a bbox which fits with view frustum and
this could be useful for getting a bbox which fits with view frustum and
object bounding boxes. In this case you crop view frustum box with objects
box
Expand Down
6 changes: 3 additions & 3 deletions docs/source/quat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Header: cglm/quat.h

What you can do with quaternions with existing functions is (Some of them):

- You can rotate transform matrix using quaterion
- You can rotate vector using quaterion
- You can create view matrix using quaterion
- You can rotate transform matrix using quaternion
- You can rotate vector using quaternion
- You can create view matrix using quaternion
- You can create a lookrotation (from source point to dest)

Table of contents (click to go):
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/aabb2d.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ glm_aabb2d_merge(vec2 aabb1[2], vec2 aabb2[2], vec2 dest[2]) {
/*!
* @brief crops a bounding aabb with another one.
*
* this could be useful for gettng a baabb which fits with view frustum and
* this could be useful for getting a baabb which fits with view frustum and
* object bounding aabbes. In this case you crop view frustum aabb with objects
* aabb
*
Expand All @@ -116,7 +116,7 @@ glm_aabb2d_crop(vec2 aabb[2], vec2 cropAabb[2], vec2 dest[2]) {
/*!
* @brief crops a bounding aabb with another one.
*
* this could be useful for gettng a baabb which fits with view frustum and
* this could be useful for getting a baabb which fits with view frustum and
* object bounding aabbes. In this case you crop view frustum aabb with objects
* aabb
*
Expand Down
2 changes: 1 addition & 1 deletion include/cglm/affine-pre.h
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ glm_rotate_z(mat4 m, float angle, mat4 dest) {
* If you need to rotate object around itself e.g. center of object or at
* some point [of object] then `glm_rotate_at()` would be better choice to do so.
*
* Even if object's model transform is identiy, rotation may not be around
* Even if object's model transform is identity, rotation may not be around
* center of object if object does not lay out at ORIGIN perfectly.
*
* Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/box.h
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ glm_aabb_merge(vec3 box1[2], vec3 box2[2], vec3 dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand All @@ -98,7 +98,7 @@ glm_aabb_crop(vec3 box[2], vec3 cropBox[2], vec3 dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/quat.h
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ glm_quat_identity_array(versor * __restrict q, size_t count) {
}

/*!
* @brief inits quaterion with raw values
* @brief inits quaternion with raw values
*
* @param[out] q quaternion
* @param[in] x x
Expand Down Expand Up @@ -749,7 +749,7 @@ glm_quat_slerp(versor from, versor to, float t, versor dest) {
*
* @param[in] from from
* @param[in] to to
* @param[in] t amout
* @param[in] t amount
* @param[out] dest result quaternion
*/
CGLM_INLINE
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/struct/aabb2d.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ glms_aabb2d_(merge)(vec2s aabb1[2], vec2s aabb2[2], vec2s dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand All @@ -86,7 +86,7 @@ glms_aabb2d_(crop)(vec2s aabb[2], vec2s cropAabb[2], vec2s dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/struct/box.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ glms_aabb_(merge)(vec3s box1[2], vec3s box2[2], vec3s dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand All @@ -86,7 +86,7 @@ glms_aabb_(crop)(vec3s box[2], vec3s cropBox[2], vec3s dest[2]) {
/*!
* @brief crops a bounding box with another one.
*
* this could be useful for gettng a bbox which fits with view frustum and
* this could be useful for getting a bbox which fits with view frustum and
* object bounding boxes. In this case you crop view frustum box with objects
* box
*
Expand Down
2 changes: 1 addition & 1 deletion include/cglm/struct/ivec2.h
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ glms_ivec2_(subs)(ivec2s v, int s) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @returns destination
*/
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/struct/ivec3.h
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ glms_ivec3_(dot)(ivec3s a, ivec3s b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector
Expand Down Expand Up @@ -253,7 +253,7 @@ glms_ivec3_(subs)(ivec3s v, int s) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @returns destination
*/
Expand Down
2 changes: 1 addition & 1 deletion include/cglm/struct/ivec4.h
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ glms_ivec4_(subs)(ivec4s v, int s) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @returns destination
*/
Expand Down
4 changes: 2 additions & 2 deletions include/cglm/struct/quat.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ glms_quat_(identity_array)(versors * __restrict q, size_t count) {
}

/*!
* @brief inits quaterion with raw values
* @brief inits quaternion with raw values
*
* @param[in] x x
* @param[in] y y
Expand Down Expand Up @@ -464,7 +464,7 @@ glms_quat_(slerp)(versors from, versors to, float t) {
*
* @param[in] from from
* @param[in] to to
* @param[in] t amout
* @param[in] t amount
* @returns result quaternion
*/
CGLM_INLINE
Expand Down

0 comments on commit d491108

Please sign in to comment.