From 4b816e3c83890b094f0394649d756b3f2eb259ba Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Sat, 18 Jun 2011 00:51:12 +0100 Subject: [PATCH] Updated doxygen doc --- glm/core/func_common.hpp | 115 +++++++++++++++++++++------------------ 1 file changed, 61 insertions(+), 54 deletions(-) diff --git a/glm/core/func_common.hpp b/glm/core/func_common.hpp index 8a1de5ad..a8f17b22 100644 --- a/glm/core/func_common.hpp +++ b/glm/core/func_common.hpp @@ -24,6 +24,13 @@ /// @file glm/core/func_common.hpp /// @date 2008-03-08 / 2010-01-26 /// @author Christophe Riccio +/// +/// @see - GLSL 4.10.6 specification, section 8.2 +/// +/// @defgroup core_func_common Common functions +/// @ingroup core +/// +/// These all operate component-wise. The description is per component. /////////////////////////////////////////////////////////////////////////////////// #ifndef glm_core_func_common @@ -33,30 +40,30 @@ namespace glm { - /// @addtogroup core_funcs + /// @addtogroup core_func_common /// @{ /// Returns x if x >= 0; otherwise, it returns -x. /// - /// @see - /// @li GLSL abs man page - /// @li GLSL 1.30.08 specification, section 8.3 + /// @see + /// @see - GLSL abs man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genFIType abs(genFIType const & x); /// Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0. /// /// @see - /// @li GLSL sign man page - /// @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL sign man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genFIType sign(genFIType const & x); //! Returns a value equal to the nearest integer that is less then or equal to x. //! /// @see - //! @li GLSL floor man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL floor man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType floor(genType const & x); @@ -64,8 +71,8 @@ namespace glm //! whose absolute value is not larger than the absolute value of x. //! /// @see - //! @li GLSL trunc man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL trunc man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType trunc(genType const & x); @@ -76,8 +83,8 @@ namespace glm //! same value as roundEven(x) for all values of x. //! /// @see - //! @li GLSL round man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL round man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType round(genType const & x); @@ -86,8 +93,8 @@ namespace glm //! integer. (Both 3.5 and 4.5 for x will return 4.0.) //! /// @see - //! @li GLSL roundEven man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL roundEven man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType roundEven(genType const & x); @@ -95,16 +102,16 @@ namespace glm //! that is greater than or equal to x. //! /// @see - //! @li GLSL ceil man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL ceil man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType ceil(genType const & x); //! Return x - floor(x). //! /// @see - //! @li GLSL fract man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL fract man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType fract(genType const & x); @@ -112,8 +119,8 @@ namespace glm //! for each component in x using the floating point value y. //! /// @see - //! @li GLSL mod man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL mod man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType mod( genType const & x, @@ -123,8 +130,8 @@ namespace glm //! for each component in x using the floating point value y. //! /// @see - //! @li GLSL mod man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL mod man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType mod( genType const & x, @@ -136,8 +143,8 @@ namespace glm //! sign as x. //! /// @see - /// @li GLSL modf man page - /// @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL modf man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType modf( genType const & x, @@ -146,8 +153,8 @@ namespace glm /// Returns y if y < x; otherwise, it returns x. /// /// @see - /// @li GLSL min man page - /// @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL min man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType min( genType const & x, @@ -161,8 +168,8 @@ namespace glm /// Returns y if x < y; otherwise, it returns x. /// /// @see - /// @li GLSL max man page - /// @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL max man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType max( genType const & x, @@ -177,8 +184,8 @@ namespace glm //! using the floating-point values minVal and maxVal. //! /// @see - //! @li GLSL clamp man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL clamp man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType clamp( genType const & x, @@ -209,8 +216,8 @@ namespace glm //! where a is a Boolean vector. //! //! @see - //! @li GLSL mix man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL mix man page + /// @see - GLSL 4.10.6 specification, section 8.3 //! //! @param[in] x Floating point scalar or vector. //! @param[in] y Floating point scalar or vector. @@ -223,8 +230,8 @@ namespace glm //! Returns 0.0 if x < edge, otherwise it returns 1.0. //! //! @see - //! @li GLSL step man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL step man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType step( genType const & edge, @@ -246,8 +253,8 @@ namespace glm //! Results are undefined if edge0 >= edge1. //! //! @see - //! @li GLSL smoothstep man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL smoothstep man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType smoothstep( genType const & edge0, @@ -267,8 +274,8 @@ namespace glm //! representations. //! //! @see - //! @li GLSL isnan man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL isnan man page + /// @see - GLSL 4.10.6 specification, section 8.3 template typename genType::bool_type isnan(genType const & x); @@ -279,8 +286,8 @@ namespace glm //! representations. //! //! @see - //! @li GLSL isinf man page - //! @li GLSL 1.30.08 specification, section 8.3 + /// @see - GLSL isinf man page + /// @see - GLSL 4.10.6 specification, section 8.3 template typename genType::bool_type isinf(genType const & x); @@ -289,8 +296,8 @@ namespace glm //! value's bit-level representation is preserved. //! //! @see - //! @li GLSL floatBitsToInt man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL floatBitsToInt man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genIType floatBitsToInt(genType const & value); @@ -299,8 +306,8 @@ namespace glm //! value's bit-level representation is preserved. //! //! @see - //! @li GLSL floatBitsToUint man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL floatBitsToUint man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genUType floatBitsToUint(genType const & value); @@ -311,8 +318,8 @@ namespace glm //! the bit-level representation is preserved. //! //! @see - //! @li GLSL intBitsToFloat man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL intBitsToFloat man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType intBitsToFloat(genIType const & value); @@ -323,16 +330,16 @@ namespace glm //! the bit-level representation is preserved. //! //! @see - //! @li GLSL uintBitsToFloat man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL uintBitsToFloat man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType uintBitsToFloat(genUType const & value); //! Computes and returns a * b + c. //! //! @see - //! @li GLSL fma man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL fma man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType fma(genType const & a, genType const & b, genType const & c); @@ -347,8 +354,8 @@ namespace glm //! infinity or is not a number, the results are undefined. //! //! @see - //! @li GLSL frexp man page - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL frexp man page + /// @see - GLSL 4.10.6 specification, section 8.3 template genType frexp(genType const & x, genIType & exp); @@ -360,8 +367,8 @@ namespace glm //! floating-point type, the result is undefined. //! //! @see - //! @li GLSL ldexp man page; - //! @li GLSL 4.00.08 specification, section 8.3 + /// @see - GLSL ldexp man page; + /// @see - GLSL 4.10.6 specification, section 8.3 template genType ldexp(genType const & x, genIType const & exp);