Skip to content

Commit

Permalink
Add doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rinzii committed Mar 2, 2024
1 parent 1398eb1 commit 9b871f6
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions include/ccmath/detail/basic/remquo.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@

namespace ccm
{
/**
* @brief Signed remainder as well as the three last bits of the division operation
* @tparam T The type of the arguments
* @param x Floating-point or integer values
* @param y Floating-point or integer values
* @param quo Pointer to int to store the sign and some bits of x / y
* @return If successful, returns the floating-point remainder of the division x / y as defined in ccm::remainder, and stores, in *quo, the sign and at least three of the least significant bits of x / y
*/
template<typename T>
inline constexpr T remquo(T x, T y, int* quo)
{
Expand Down

0 comments on commit 9b871f6

Please sign in to comment.