From 438bd52bf34820320fef8b6a25e3e86056c559cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 22 Nov 2012 15:27:08 +0100 Subject: [PATCH] Doc++ --- src/Math/Constants.h | 7 ++----- src/Math/MathTypeTraits.h | 12 +++++++----- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/src/Math/Constants.h b/src/Math/Constants.h index a4c8a50e5..0cad0759e 100644 --- a/src/Math/Constants.h +++ b/src/Math/Constants.h @@ -21,12 +21,9 @@ namespace Magnum { namespace Math { -/** -@brief Numeric constants - -@internal See MathTypeTraits class for implementation notes. -*/ +/** @brief Numeric constants */ template struct Constants { + /* See MathTypeTraits for answer why these are functions and not constants. */ #ifdef DOXYGEN_GENERATING_OUTPUT /** * @brief Pi diff --git a/src/Math/MathTypeTraits.h b/src/Math/MathTypeTraits.h index 53413f4ae..a0b9f591d 100644 --- a/src/Math/MathTypeTraits.h +++ b/src/Math/MathTypeTraits.h @@ -44,13 +44,15 @@ specialization for given types. This class and class methods are specialized only for types where it makes sense, it has empty implementation for unknown types or types which don't support given feature, thus forcing the compilation stop with an error. - -@internal The following values are implemented as inline functions, not as - static const variables, because the compiler will inline the return values - instead of referencing to static data and unlike static const variables - the functions can be overloaded, deleted and hidden. */ template struct MathTypeTraits { + /* + * The following values are implemented as inline functions, not as + * static const variables, because the compiler will inline the return + * values instead of referencing to static data and unlike static const + * variables the functions can be overloaded, deleted and hidden. + */ + #ifdef DOXYGEN_GENERATING_OUTPUT /** * @brief Corresponding numeric type large at least as 32bit integer