Skip to content
This repository has been archived by the owner on Dec 23, 2024. It is now read-only.

Commit

Permalink
add missing doxygen style comments
Browse files Browse the repository at this point in the history
  • Loading branch information
MGTheTrain committed Apr 16, 2024
1 parent a44b801 commit 1af11c4
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion modules/core/include/math-utils.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,52 @@
extern "C" {
#endif

/**
* @brief Adds two integers.
* @param a The first integer.
* @param b The second integer.
* @return The sum of a and b.
*/
int32_t add(int32_t a, int32_t b);

/**
* @brief Subtracts one integer from another.
* @param a The integer to subtract from.
* @param b The integer to subtract.
* @return The result of subtracting b from a.
*/
int32_t subtract(int32_t a, int32_t b);

/**
* @brief Multiplies two integers.
* @param a The first integer.
* @param b The second integer.
* @return The product of a and b.
*/
int32_t multiply(int32_t a, int32_t b);

/**
* @brief Divides one float by another.
* @param a The float to divide.
* @param b The divisor.
* @return The result of dividing a by b.
* @throw Division by zero error if b is zero.
*/
float divide(float a, float b);

/**
* @brief Calculates the area of the circle.
* @param radius The radius of the circle.
* @return The area of the circle.
*/
float getCircleArea(float radius);
float getCircleCircumference(float radius);

/**
* @brief Calculates the circumference of the circle.
* @param radius The radius of the circle
* @return The circumference of the circle.
*/
float getCircleCircumference(float radius);
#ifdef __cplusplus
}
#endif

0 comments on commit 1af11c4

Please sign in to comment.