From ac6f0c9b58d44e5b6a3f9da475aaf1faf1f6ff2d Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Fri, 17 Jun 2011 21:11:35 +0100 Subject: [PATCH] Updated doxygen doc --- glm/core/func_exponential.hpp | 78 +++++++++++++++++++++-------------- glm/gtc/half_float.hpp | 1 - 2 files changed, 46 insertions(+), 33 deletions(-) diff --git a/glm/core/func_exponential.hpp b/glm/core/func_exponential.hpp index a182ca33..b771db86 100644 --- a/glm/core/func_exponential.hpp +++ b/glm/core/func_exponential.hpp @@ -24,6 +24,13 @@ /// @file glm/core/func_exponential.hpp /// @date 2008-08-08 / 2011-06-14 /// @author Christophe Riccio +/// +/// @see - GLSL 4.10.6 specification, section 8.2 +/// +/// @defgroup core_func_exponential Exponential functions +/// @ingroup core +/// +/// These all operate component-wise. The description is per component. /////////////////////////////////////////////////////////////////////////////////// #ifndef glm_core_func_exponential @@ -31,58 +38,65 @@ namespace glm { - /// @addtogroup core_funcs + /// @addtogroup core_func_exponential /// @{ - //! Returns x raised to the y power. - //! - //! \li GLSL pow man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns x raised to the y power. + /// + /// @see + /// @see - GLSL pow man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType pow(genType const & x, genType const & y); - //! Returns the natural exponentiation of x, i.e., e^x. - //! - //! \li GLSL exp man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns the natural exponentiation of x, i.e., e^x. + /// + /// @see + /// @see - GLSL exp man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType exp(genType const & x); - //! Returns the natural logarithm of x, i.e., - //! returns the value y which satisfies the equation x = e^y. - //! Results are undefined if x <= 0. - //! - //! \li GLSL log man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns the natural logarithm of x, i.e., + /// returns the value y which satisfies the equation x = e^y. + /// Results are undefined if x <= 0. + /// + /// @see + /// @see - GLSL log man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType log(genType const & x); - //! Returns 2 raised to the x power. - //! - //! \li GLSL exp2 man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns 2 raised to the x power. + /// + /// @see + /// @see - GLSL exp2 man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType exp2(genType const & x); - //! Returns the base 2 log of x, i.e., returns the value y, - //! which satisfies the equation x = 2 ^ y. - //! - //! \li GLSL log2 man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns the base 2 log of x, i.e., returns the value y, + /// which satisfies the equation x = 2 ^ y. + /// + /// @see + /// @see - GLSL log2 man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType log2(genType const & x); - //! Returns the positive square root of x. - //! - //! \li GLSL sqrt man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns the positive square root of x. + /// + /// @see + /// @see - GLSL sqrt man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType sqrt(genType const & x); - //! Returns the reciprocal of the positive square root of x. - //! - //! \li GLSL inversesqrt man page - //! \li GLSL 1.30.08 specification, section 8.2 + /// Returns the reciprocal of the positive square root of x. + /// + /// @see + /// @see - GLSL inversesqrt man page + /// @see - GLSL 4.10.6 specification, section 8.2 template genType inversesqrt(genType const & x); diff --git a/glm/gtc/half_float.hpp b/glm/gtc/half_float.hpp index 5f3ebd7a..9fe50f64 100644 --- a/glm/gtc/half_float.hpp +++ b/glm/gtc/half_float.hpp @@ -32,7 +32,6 @@ /// /// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices. /// need to be included to use these functionalities. -/// /////////////////////////////////////////////////////////////////////////////////// #ifndef GLM_GTC_half_float