Browse Source

Updated doxygen doc

Christophe Riccio 14 years ago
parent
commit
ac6f0c9b58
2 changed files with 46 additions and 33 deletions
  1. 46 32
      glm/core/func_exponential.hpp
  2. 0 1
      glm/gtc/half_float.hpp

+ 46 - 32
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 - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
+///
+/// @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 <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a>
-    //! \li GLSL 1.30.08 specification, section 8.2
+	/// Returns x raised to the y power. 
+    ///
+	/// @see
+    /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	genType pow(genType const & x, genType const & y);
 
-	//! Returns the natural exponentiation of x, i.e., e^x.
-    //! 
-    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a>
-    //! \li GLSL 1.30.08 specification, section 8.2
+	/// Returns the natural exponentiation of x, i.e., e^x.
+    /// 
+	/// @see
+    /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	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 <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a>
-    //! \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 - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	genType log(genType const & x);
 
-	//! Returns 2 raised to the x power.
-    //! 
-    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a>
-    //! \li GLSL 1.30.08 specification, section 8.2
+	/// Returns 2 raised to the x power.
+    /// 
+	/// @see
+    /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	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 <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a>
-    //! \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 - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	genType log2(genType const & x);
 
-	//! Returns the positive square root of x.
-    //! 
-    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a>
-    //! \li GLSL 1.30.08 specification, section 8.2
+	/// Returns the positive square root of x.
+    /// 
+	/// @see
+    /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	genType sqrt(genType const & x);
     
-	//! Returns the reciprocal of the positive square root of x.
-    //! 
-    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a>
-    //! \li GLSL 1.30.08 specification, section 8.2
+	/// Returns the reciprocal of the positive square root of x.
+    /// 
+	/// @see
+    /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a>
+    /// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
 	template <typename genType> 
 	genType inversesqrt(genType const & x);
 

+ 0 - 1
glm/gtc/half_float.hpp

@@ -32,7 +32,6 @@
 /// 
 /// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices.
 /// <glm/gtc/half_float.hpp> need to be included to use these functionalities.
-///
 ///////////////////////////////////////////////////////////////////////////////////
 
 #ifndef GLM_GTC_half_float