Browse Source

Doc++

pull/7/head
Vladimír Vondruš 14 years ago
parent
commit
438bd52bf3
  1. 7
      src/Math/Constants.h
  2. 12
      src/Math/MathTypeTraits.h

7
src/Math/Constants.h

@ -21,12 +21,9 @@
namespace Magnum { namespace Math { namespace Magnum { namespace Math {
/** /** @brief Numeric constants */
@brief Numeric constants
@internal See MathTypeTraits class for implementation notes.
*/
template<class T> struct Constants { template<class T> struct Constants {
/* See MathTypeTraits for answer why these are functions and not constants. */
#ifdef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT
/** /**
* @brief Pi * @brief Pi

12
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 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 sense, it has empty implementation for unknown types or types which don't
support given feature, thus forcing the compilation stop with an error. 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<class T> struct MathTypeTraits { template<class T> 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 #ifdef DOXYGEN_GENERATING_OUTPUT
/** /**
* @brief Corresponding numeric type large at least as 32bit integer * @brief Corresponding numeric type large at least as 32bit integer

Loading…
Cancel
Save