Browse Source

Clarified comments in GTC_epsilon, issue #69

Christophe Riccio 12 years ago
parent
commit
a67c7594bc
1 changed files with 12 additions and 4 deletions
  1. 12 4
      glm/gtc/epsilon.hpp

+ 12 - 4
glm/gtc/epsilon.hpp

@@ -54,7 +54,9 @@ namespace glm
 	/// @addtogroup gtc_epsilon
 	/// @{
 
-	/// Returns the component-wise compare of |x - y| < epsilon.
+	/// Returns the component-wise comparison of |x - y| < epsilon.
+	/// True if this expression is satisfied.
+	///
 	/// @see gtc_epsilon
 	template <typename genType>
 	typename genType::boolType epsilonEqual(
@@ -62,7 +64,9 @@ namespace glm
 		genType const & y,
 		typename genType::value_type const & epsilon);
 
-	/// Returns the component-wise compare of |x - y| < epsilon.
+	/// Returns the component-wise comparison of |x - y| < epsilon.
+	/// True if this expression is satisfied.
+	///
 	/// @see gtc_epsilon
 	template <typename genType> 
 	typename genType::boolType epsilonEqual(
@@ -70,7 +74,9 @@ namespace glm
 		genType const & y, 
 		genType const & epsilon);
 
-	/// Returns the component-wise compare of |x - y| < epsilon.
+	/// Returns the component-wise comparison of |x - y| < epsilon.
+	/// True if this expression is not satisfied.
+	///
 	/// @see gtc_epsilon
 	template <typename genType>
 	typename genType::boolType epsilonNotEqual(
@@ -78,7 +84,9 @@ namespace glm
 		genType const & y,
 		typename genType::value_type const & epsilon);
 
-	/// Returns the component-wise compare of |x - y| >= epsilon.
+	/// Returns the component-wise comparison of |x - y| >= epsilon.
+	/// True if this expression is not satisfied.
+	///
 	/// @see gtc_epsilon
 	template <typename genType>
 	typename genType::boolType epsilonNotEqual(