From de2ca0021751cb747060397f660d62337138a4d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 1 Nov 2013 10:01:51 +0100 Subject: [PATCH] Math: doc++ --- src/Math/Functions.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/Math/Functions.h b/src/Math/Functions.h index cef9fde4e..5ba6dd1be 100644 --- a/src/Math/Functions.h +++ b/src/Math/Functions.h @@ -344,8 +344,9 @@ Converts integral value from full range of given *unsigned* integral type to value in range @f$ [0, 1] @f$ or from *signed* integral to range @f$ [-1, 1] @f$. @note For best precision, resulting `FloatingPoint` type should be always - larger that `Integral` type (e.g. Double from Int, LongDouble from Long and - similarly for vector types). + larger that `Integral` type (e.g. @ref Magnum::Float "Float" from + @ref Magnum::Short "Short", @ref Magnum::Double "Double" from + @ref Magnum::Int "Int" and similarly for vector types). @attention To ensure the integral type is correctly detected when using literals, this function should be called with both template parameters @@ -358,7 +359,7 @@ Float a = normalize('\xFF'); Float b = normalize('\xFF'); @endcode -@see denormalize() +@see @ref denormalize() */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline FloatingPoint normalize(const Integral& value); @@ -393,13 +394,14 @@ Converts floating-point value in range @f$ [0, 1] @f$ to full range of given integral type. @note For best precision, `FloatingPoint` type should be always larger that - resulting `Integral` type (e.g. Double to Int, LongDouble to Long and - similarly for vector types). + resulting `Integral` type (e.g. @ref Magnum::Float "Float" to + @ref Magnum::Short "Short", @ref Magnum::Double "Double" to @ref Magnum::Int "Int" + and similarly for vector types). @attention Return value for floating point numbers outside the normalized range is undefined. -@see normalize() +@see @ref normalize() */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline Integral denormalize(const FloatingPoint& value);