Clean up special symbols from docstrings

This commit is contained in:
Imbus 2025-05-23 17:50:00 +02:00
parent f83fabf980
commit 5a2daa18df

View file

@ -10,7 +10,7 @@
*/ */
/** /**
* @brief A 2×2 matrix stored in row-major order. * @brief A 2x2 matrix stored in row-major order.
* *
* The elements are laid out as: * The elements are laid out as:
* [ arr[0] arr[1] ] * [ arr[0] arr[1] ]
@ -21,7 +21,7 @@ typedef struct Mat2 {
} Mat2; } Mat2;
/** /**
* @brief A 3×3 matrix stored in row-major order. * @brief A 3x3 matrix stored in row-major order.
* *
* The elements are laid out as: * The elements are laid out as:
* [ arr[0] arr[1] arr[2] ] * [ arr[0] arr[1] arr[2] ]
@ -51,7 +51,7 @@ typedef struct Vec3 {
* *
* @param a Pointer to the first vector. * @param a Pointer to the first vector.
* @param b Pointer to the second vector. * @param b Pointer to the second vector.
* @return The dot product (a b). * @return The dot product (a * b).
*/ */
inline float vec3_dot(const Vec3 *a, const Vec3 *b); inline float vec3_dot(const Vec3 *a, const Vec3 *b);
@ -60,7 +60,7 @@ inline float vec3_dot(const Vec3 *a, const Vec3 *b);
* *
* @param a Pointer to the first vector. * @param a Pointer to the first vector.
* @param b Pointer to the second vector. * @param b Pointer to the second vector.
* @return The cross product vector (a × b). * @return The cross product vector (a x b).
*/ */
Vec3 vec3_cross(const Vec3 *a, const Vec3 *b); Vec3 vec3_cross(const Vec3 *a, const Vec3 *b);
@ -96,7 +96,7 @@ Vec3 vec3_scale(const Vec3 *a, const float scalar);
* *
* @param a Pointer to the first vector. * @param a Pointer to the first vector.
* @param b Pointer to the second vector. * @param b Pointer to the second vector.
* @return The dot product (a b). * @return The dot product (a * b).
*/ */
inline float vec2_dot(const Vec2 *a, const Vec2 *b); inline float vec2_dot(const Vec2 *a, const Vec2 *b);
@ -127,7 +127,7 @@ Vec2 vec2_add(const Vec2 *a, const Vec2 *b);
*/ */
Vec2 vec2_scale(const Vec2 *a, const float scalar); Vec2 vec2_scale(const Vec2 *a, const float scalar);
/** /**
* @brief Computes the determinant of a 2×2 matrix. * @brief Computes the determinant of a 2x2 matrix.
* *
* @param m Pointer to the matrix. * @param m Pointer to the matrix.
* @return The determinant of the matrix. * @return The determinant of the matrix.
@ -135,7 +135,7 @@ Vec2 vec2_scale(const Vec2 *a, const float scalar);
float mat2_det(const Mat2 *m); float mat2_det(const Mat2 *m);
/** /**
* @brief Computes the determinant of a 3×3 matrix (row-major order). * @brief Computes the determinant of a 3x3 matrix (row-major order).
* *
* @param m Pointer to the matrix. * @param m Pointer to the matrix.
* @return The determinant of the matrix. * @return The determinant of the matrix.
@ -143,25 +143,25 @@ float mat2_det(const Mat2 *m);
float mat3_det2(const Mat3 *m); float mat3_det2(const Mat3 *m);
/** /**
* @brief Multiplies two 2×2 matrices (row-major order). * @brief Multiplies two 2x2 matrices (row-major order).
* *
* @param m1 Pointer to the first matrix. * @param m1 Pointer to the first matrix.
* @param m2 Pointer to the second matrix. * @param m2 Pointer to the second matrix.
* @return The resulting matrix product (m1 × m2). * @return The resulting matrix product (m1 x m2).
*/ */
Mat2 mat2_mul(const Mat2 *m1, const Mat2 *m2); Mat2 mat2_mul(const Mat2 *m1, const Mat2 *m2);
/** /**
* @brief Multiplies two 3×3 matrices (row-major order). * @brief Multiplies two 3x3 matrices (row-major order).
* *
* @param m1 Pointer to the first matrix. * @param m1 Pointer to the first matrix.
* @param m2 Pointer to the second matrix. * @param m2 Pointer to the second matrix.
* @return The resulting matrix product (m1 × m2). * @return The resulting matrix product (m1 x m2).
*/ */
Mat3 mat3_mul(const Mat3 *m1, const Mat3 *m2); Mat3 mat3_mul(const Mat3 *m1, const Mat3 *m2);
/** /**
* @brief Checks if two 2×2 matrices are approximately equal. * @brief Checks if two 2x2 matrices are approximately equal.
* *
* @param a Pointer to the first matrix. * @param a Pointer to the first matrix.
* @param b Pointer to the second matrix. * @param b Pointer to the second matrix.
@ -171,7 +171,7 @@ Mat3 mat3_mul(const Mat3 *m1, const Mat3 *m2);
bool mat2_approx_eq(const Mat2 *a, const Mat2 *b, float epsilon); bool mat2_approx_eq(const Mat2 *a, const Mat2 *b, float epsilon);
/** /**
* @brief Checks if two 3×3 matrices are approximately equal. * @brief Checks if two 3x3 matrices are approximately equal.
* *
* @param a Pointer to the first matrix. * @param a Pointer to the first matrix.
* @param b Pointer to the second matrix. * @param b Pointer to the second matrix.
@ -181,7 +181,7 @@ bool mat2_approx_eq(const Mat2 *a, const Mat2 *b, float epsilon);
bool mat3_approx_eq(const Mat3 *a, const Mat3 *b, float epsilon); bool mat3_approx_eq(const Mat3 *a, const Mat3 *b, float epsilon);
/** /**
* @brief Checks if two 3×3 vectors are approximately equal. * @brief Checks if two 3x3 vectors are approximately equal.
* *
* @param a Pointer to the first vector. * @param a Pointer to the first vector.
* @param b Pointer to the second vector. * @param b Pointer to the second vector.