Browse Source

Added links to GLSL man pages for noise functions

Christophe Riccio 14 years ago
parent
commit
880026c083
1 changed files with 16 additions and 8 deletions
  1. 16 8
      glm/core/func_noise.hpp

+ 16 - 8
glm/core/func_noise.hpp

@@ -24,23 +24,31 @@ namespace glm
 	/// \addtogroup core_funcs
 	///@{
 
-	// Returns a 1D noise value based on the input value x.
-	// From GLSL 1.30.08 specification, section 8.9.
+	//! Returns a 1D noise value based on the input value x.
+    //! 
+    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise1.xml">GLSL noise1 man page</a>
+	//! \li GLSL 1.30.08 specification, section 8.9
 	template <typename genType>
 	typename genType::value_type noise1(genType const & x);
 
-	// Returns a 2D noise value based on the input value x.
-	// From GLSL 1.30.08 specification, section 8.9.
+	//! Returns a 2D noise value based on the input value x.
+    //! 
+    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise2.xml">GLSL noise2 man page</a>
+    //! \li GLSL 1.30.08 specification, section 8.9
 	template <typename genType>
 	detail::tvec2<typename genType::value_type> noise2(genType const & x);
 
-	// Returns a 3D noise value based on the input value x.
-	// From GLSL 1.30.08 specification, section 8.9.
+	//! Returns a 3D noise value based on the input value x.
+    //! 
+    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise3.xml">GLSL noise3 man page</a>
+    //! \li GLSL 1.30.08 specification, section 8.9
 	template <typename genType>
 	detail::tvec3<typename genType::value_type> noise3(genType const & x);
 
-	// Returns a 4D noise value based on the input value x.
-	// From GLSL 1.30.08 specification, section 8.9.
+	//! Returns a 4D noise value based on the input value x.
+    //! 
+    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise4.xml">GLSL noise4 man page</a>
+    //! \li GLSL 1.30.08 specification, section 8.9
 	template <typename genType>
 	detail::tvec4<typename genType::value_type> noise4(genType const & x);