Improve documentation
Former-commit-id: 08d70f6a53a7f12d2748d145d1fe139595a1b39e
This commit is contained in:
@@ -99,6 +99,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Approaches the objective, beginning with value and with increment
|
||||
* \return The nearest value of the objective you can get with the value and the increment for one step
|
||||
*
|
||||
@@ -120,6 +121,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Clamps value between min and max and returns the expected value
|
||||
* \return If value is not in the interval of min..max, value obtained is the nearest limit of this interval
|
||||
*
|
||||
@@ -135,6 +137,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets number of bits set in the number
|
||||
* \return The number of bits set to 1
|
||||
*
|
||||
@@ -157,6 +160,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Converts degree to radian
|
||||
* \return The representation in radian of the angle in degree (0..2*pi)
|
||||
*
|
||||
@@ -170,6 +174,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the unit from degree and convert it according to NAZARA_MATH_ANGLE_RADIAN
|
||||
* \return Express the degrees
|
||||
*
|
||||
@@ -187,6 +192,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the unit from radian and convert it according to NAZARA_MATH_ANGLE_RADIAN
|
||||
* \return Express the radians
|
||||
*
|
||||
@@ -204,6 +210,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the nearest power of two for the number
|
||||
* \return First power of two containing the number
|
||||
*
|
||||
@@ -222,6 +229,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -249,6 +257,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -270,6 +279,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -285,6 +295,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -301,6 +312,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -316,6 +328,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits
|
||||
*
|
||||
@@ -332,6 +345,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits + 1 for the dot
|
||||
*
|
||||
@@ -346,6 +360,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits + 1 for the dot
|
||||
*
|
||||
@@ -360,6 +375,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the number of digits to represent the number in base 10
|
||||
* \return Number of digits + 1 for the dot
|
||||
*
|
||||
@@ -374,6 +390,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the log in base 2 of integral number
|
||||
* \return Log of the number (floor)
|
||||
*
|
||||
@@ -391,6 +408,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the log in base 2 of integral number, only works for power of two !
|
||||
* \return Log of the number
|
||||
*
|
||||
@@ -408,6 +426,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the power of integrals
|
||||
* \return base^exponent for integral
|
||||
*
|
||||
@@ -426,6 +445,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Interpolates the value to other one with a factor of interpolation
|
||||
* \return A new value which is the interpolation of two values
|
||||
*
|
||||
@@ -446,6 +466,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Multiplies X and Y, then add Z
|
||||
* \return The result of X * Y + Z
|
||||
*
|
||||
@@ -487,6 +508,7 @@ namespace Nz
|
||||
#endif
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Normalizes the angle
|
||||
* \return Normalized value between 0..2*(pi if radian or 180 if degrees)
|
||||
*
|
||||
@@ -512,6 +534,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Checks whether two numbers are equal
|
||||
* \return true if they are equal within a certain epsilon
|
||||
*
|
||||
@@ -527,6 +550,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Checks whether two numbers are equal
|
||||
* \return true if they are equal within the max difference
|
||||
*
|
||||
@@ -547,6 +571,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Converts the number to String
|
||||
* \return String representation of the number
|
||||
*
|
||||
@@ -598,6 +623,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Converts radian to degree
|
||||
* \return The representation in degree of the angle in radian (0..360)
|
||||
*
|
||||
@@ -611,6 +637,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Converts the string to number
|
||||
* \return Number which is represented by the string
|
||||
*
|
||||
@@ -672,6 +699,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the degree from unit and convert it according to NAZARA_MATH_ANGLE_RADIAN
|
||||
* \return Express in degrees
|
||||
*
|
||||
@@ -689,6 +717,7 @@ namespace Nz
|
||||
}
|
||||
|
||||
/*!
|
||||
* \ingroup math
|
||||
* \brief Gets the radian from unit and convert it according to NAZARA_MATH_ANGLE_RADIAN
|
||||
* \return Express in radians
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user