Browse Source

Fixed doxygen warnings

Christophe Riccio 8 years ago
parent
commit
e1dc14ddd4
3 changed files with 30 additions and 58 deletions
  1. 1 17
      glm/common.hpp
  2. 0 24
      glm/gtc/integer.hpp
  3. 29 17
      glm/gtc/round.hpp

+ 1 - 17
glm/common.hpp

@@ -138,25 +138,9 @@ namespace glm
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
 	GLM_FUNC_DECL vec<L, T, Q> fract(vec<L, T, Q> const& x);
 	GLM_FUNC_DECL vec<L, T, Q> fract(vec<L, T, Q> const& x);
 
 
-	/// Modulus. Returns x - y * floor(x / y)
-	/// for each component in x using the floating point value y.
-	///
-	/// @tparam genType Floating-point scalar or vector types.
-	///
-	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
-	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
 	template<typename genType>
 	template<typename genType>
 	GLM_FUNC_DECL genType mod(genType x, genType y);
 	GLM_FUNC_DECL genType mod(genType x, genType y);
 
 
-	/// Modulus. Returns x - y * floor(x / y)
-	/// for each component in x using the floating point value y.
-	///
-	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
-	/// @tparam T Floating-point scalar types
-	/// @tparam Q Value from qualifier enum
-	///
-	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
-	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, T y);
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, T y);
 
 
@@ -164,7 +148,7 @@ namespace glm
 	/// for each component in x using the floating point value y.
 	/// for each component in x using the floating point value y.
 	///
 	///
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
-	/// @tparam T Floating-point scalar types
+	/// @tparam T Floating-point scalar types, include glm/gtc/integer for integer scalar types support
 	/// @tparam Q Value from qualifier enum
 	/// @tparam Q Value from qualifier enum
 	///
 	///
 	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
 	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>

+ 0 - 24
glm/gtc/integer.hpp

@@ -35,36 +35,12 @@ namespace glm
 	template<typename genIUType>
 	template<typename genIUType>
 	GLM_FUNC_DECL genIUType log2(genIUType x);
 	GLM_FUNC_DECL genIUType log2(genIUType x);
 
 
-	/// Modulus. Returns x % y
-	/// for each component in x using the floating point value y.
-	///
-	/// @tparam genIUType Integer-point scalar or vector types.
-	///
-	/// @see gtc_integer
-	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
-	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
 	template<typename genIUType>
 	template<typename genIUType>
 	GLM_FUNC_DECL genIUType mod(genIUType x, genIUType y);
 	GLM_FUNC_DECL genIUType mod(genIUType x, genIUType y);
 
 
-	/// Modulus. Returns x % y
-	/// for each component in x using the floating point value y.
-	///
-	/// @tparam T Integer scalar types.
-	///
-	/// @see gtc_integer
-	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
-	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, T y);
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, T y);
 
 
-	/// Modulus. Returns x % y
-	/// for each component in x using the floating point value y.
-	///
-	/// @tparam T Integer scalar types.
-	///
-	/// @see gtc_integer
-	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
-	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
 	GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
 
 

+ 29 - 17
glm/gtc/round.hpp

@@ -34,7 +34,7 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genIUType>
 	template<typename genIUType>
-	GLM_FUNC_DECL bool isPowerOfTwo(genIUType Value);
+	GLM_FUNC_DECL bool isPowerOfTwo(genIUType v);
 
 
 	/// Return true if the value is a power of two number.
 	/// Return true if the value is a power of two number.
 	///
 	///
@@ -44,14 +44,14 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, bool, Q> isPowerOfTwo(vec<L, T, Q> const& value);
+	GLM_FUNC_DECL vec<L, bool, Q> isPowerOfTwo(vec<L, T, Q> const& v);
 
 
 	/// Return the power of two number which value is just higher the input value,
 	/// Return the power of two number which value is just higher the input value,
 	/// round up to a power of two.
 	/// round up to a power of two.
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genIUType>
 	template<typename genIUType>
-	GLM_FUNC_DECL genIUType ceilPowerOfTwo(genIUType Value);
+	GLM_FUNC_DECL genIUType ceilPowerOfTwo(genIUType v);
 
 
 	/// Return the power of two number which value is just higher the input value,
 	/// Return the power of two number which value is just higher the input value,
 	/// round up to a power of two.
 	/// round up to a power of two.
@@ -62,14 +62,14 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> ceilPowerOfTwo(vec<L, T, Q> const& value);
+	GLM_FUNC_DECL vec<L, T, Q> ceilPowerOfTwo(vec<L, T, Q> const& v);
 
 
 	/// Return the power of two number which value is just lower the input value,
 	/// Return the power of two number which value is just lower the input value,
 	/// round down to a power of two.
 	/// round down to a power of two.
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genIUType>
 	template<typename genIUType>
-	GLM_FUNC_DECL genIUType floorPowerOfTwo(genIUType Value);
+	GLM_FUNC_DECL genIUType floorPowerOfTwo(genIUType v);
 
 
 	/// Return the power of two number which value is just lower the input value,
 	/// Return the power of two number which value is just lower the input value,
 	/// round down to a power of two.
 	/// round down to a power of two.
@@ -80,13 +80,13 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> floorPowerOfTwo(vec<L, T, Q> const& value);
+	GLM_FUNC_DECL vec<L, T, Q> floorPowerOfTwo(vec<L, T, Q> const& v);
 
 
 	/// Return the power of two number which value is the closet to the input value.
 	/// Return the power of two number which value is the closet to the input value.
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genIUType>
 	template<typename genIUType>
-	GLM_FUNC_DECL genIUType roundPowerOfTwo(genIUType Value);
+	GLM_FUNC_DECL genIUType roundPowerOfTwo(genIUType v);
 
 
 	/// Return the power of two number which value is the closet to the input value.
 	/// Return the power of two number which value is the closet to the input value.
 	///
 	///
@@ -96,13 +96,13 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> roundPowerOfTwo(vec<L, T, Q> const& value);
+	GLM_FUNC_DECL vec<L, T, Q> roundPowerOfTwo(vec<L, T, Q> const& v);
 
 
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genIUType>
 	template<typename genIUType>
-	GLM_FUNC_DECL bool isMultiple(genIUType Value, genIUType Multiple);
+	GLM_FUNC_DECL bool isMultiple(genIUType v, genIUType Multiple);
 
 
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	///
 	///
@@ -112,7 +112,7 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, bool, Q> isMultiple(vec<L, T, Q> const& Value, T Multiple);
+	GLM_FUNC_DECL vec<L, bool, Q> isMultiple(vec<L, T, Q> const& v, T Multiple);
 
 
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	/// Return true if the 'Value' is a multiple of 'Multiple'.
 	///
 	///
@@ -122,67 +122,79 @@ namespace glm
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, bool, Q> isMultiple(vec<L, T, Q> const& Value, vec<L, T, Q> const& Multiple);
+	GLM_FUNC_DECL vec<L, bool, Q> isMultiple(vec<L, T, Q> const& v, vec<L, T, Q> const& Multiple);
 
 
 	/// Higher multiple number of Source.
 	/// Higher multiple number of Source.
 	///
 	///
 	/// @tparam genType Floating-point or integer scalar or vector types.
 	/// @tparam genType Floating-point or integer scalar or vector types.
+	///
+	/// @param v Source value to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genType>
 	template<typename genType>
-	GLM_FUNC_DECL genType ceilMultiple(genType Source, genType Multiple);
+	GLM_FUNC_DECL genType ceilMultiple(genType v, genType Multiple);
 
 
 	/// Higher multiple number of Source.
 	/// Higher multiple number of Source.
 	///
 	///
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam Q Value from qualifier enum
 	/// @tparam Q Value from qualifier enum
+	///
+	/// @param v Source values to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> ceilMultiple(vec<L, T, Q> const& Source, vec<L, T, Q> const& Multiple);
+	GLM_FUNC_DECL vec<L, T, Q> ceilMultiple(vec<L, T, Q> const& v, vec<L, T, Q> const& Multiple);
 
 
 	/// Lower multiple number of Source.
 	/// Lower multiple number of Source.
 	///
 	///
 	/// @tparam genType Floating-point or integer scalar or vector types.
 	/// @tparam genType Floating-point or integer scalar or vector types.
+	///
+	/// @param v Source value to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genType>
 	template<typename genType>
-	GLM_FUNC_DECL genType floorMultiple(genType Source, genType Multiple);
+	GLM_FUNC_DECL genType floorMultiple(genType v, genType Multiple);
 
 
 	/// Lower multiple number of Source.
 	/// Lower multiple number of Source.
 	///
 	///
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam Q Value from qualifier enum
 	/// @tparam Q Value from qualifier enum
+	///
+	/// @param v Source values to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> floorMultiple(vec<L, T, Q> const& Source, vec<L, T, Q> const& Multiple);
+	GLM_FUNC_DECL vec<L, T, Q> floorMultiple(vec<L, T, Q> const& v, vec<L, T, Q> const& Multiple);
 
 
 	/// Lower multiple number of Source.
 	/// Lower multiple number of Source.
 	///
 	///
 	/// @tparam genType Floating-point or integer scalar or vector types.
 	/// @tparam genType Floating-point or integer scalar or vector types.
+	///
+	/// @param v Source value to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<typename genType>
 	template<typename genType>
-	GLM_FUNC_DECL genType roundMultiple(genType Source, genType Multiple);
+	GLM_FUNC_DECL genType roundMultiple(genType v, genType Multiple);
 
 
 	/// Lower multiple number of Source.
 	/// Lower multiple number of Source.
 	///
 	///
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam T Floating-point or integer scalar types
 	/// @tparam Q Value from qualifier enum
 	/// @tparam Q Value from qualifier enum
+	///
+	/// @param v Source values to which is applied the function
 	/// @param Multiple Must be a null or positive value
 	/// @param Multiple Must be a null or positive value
 	///
 	///
 	/// @see gtc_round
 	/// @see gtc_round
 	template<length_t L, typename T, qualifier Q>
 	template<length_t L, typename T, qualifier Q>
-	GLM_FUNC_DECL vec<L, T, Q> roundMultiple(vec<L, T, Q> const& Source, vec<L, T, Q> const& Multiple);
+	GLM_FUNC_DECL vec<L, T, Q> roundMultiple(vec<L, T, Q> const& v, vec<L, T, Q> const& Multiple);
 
 
 	/// @}
 	/// @}
 } //namespace glm
 } //namespace glm