From 5297e705a6455acb531f7990892a2e6406be6b28 Mon Sep 17 00:00:00 2001
From: Danilo <borges_santos89@hotmail.com>
Date: Tue, 10 Sep 2024 14:21:44 -0300
Subject: [PATCH] =?UTF-8?q?Adiciona=20coment=C3=A1rios=20a=20MathHelper?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 includes/xna/common/math.hpp | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/includes/xna/common/math.hpp b/includes/xna/common/math.hpp
index e677068..033f534 100644
--- a/includes/xna/common/math.hpp
+++ b/includes/xna/common/math.hpp
@@ -5,18 +5,25 @@
 #include <cmath>
 
 namespace xna {
+	//Contains commonly used precalculated values. 
 	struct MathHelper {
+		//Represents the mathematical constant e.
 		static constexpr double E = 2.7182818284590451;
+		//Represents the value of pi.
 		static constexpr double PI = 3.1415926535897931;
-		static constexpr double TAU = 6.2831853071795862;
-		static constexpr double EPSILON = 4.94065645841247E-324;
 
+		//Converts degrees to radians.
 		static constexpr float ToRadians(float degrees) { return degrees * (static_cast<float>(PI) / 180.0f); }
+		//Converts radians to degrees.
 		static constexpr float ToDegrees(float radians) { return radians * 57.2957764F; }
+		//Calculates the absolute value of the difference of two values
 		static float Distance(float value1, float value2) { return std::abs(value1 - value2); }
+		//Returns the lesser of two values.
 		static constexpr float Min(float value1, float value2) { return (std::min)(value1, value2); }
+		//Returns the greater of two values.
 		static constexpr float Max(float value1, float value2) { return (std::max)(value1, value2); }
 
+		//Restricts a value to be within a specified range.
 		template <typename T>
 		static constexpr T Clamp(T value, T min, T max) {
 			value = value > max ? max : value;
@@ -24,25 +31,30 @@ namespace xna {
 			return value;
 		}
 
+		//Linearly interpolates between two values.
 		static constexpr float Lerp(float value1, float value2, float amount) {
 			return value1 + (value2 - value1) * amount;
 		}
 
+		//Returns the Cartesian coordinate for one axis of a point that is defined by a given triangle and two normalized barycentric (areal) coordinates.
 		static constexpr float Barycentric(float value1, float value2, float value3, float amount1, float amount2) {
 			return value1 + amount1 * (value2 - value1) + amount2 * (value3 - value1);
 		}
 
+		//Interpolates between two values using a cubic equation.
 		static constexpr float SmoothStep(float value1, float value2, float amount) {
 			const auto num = Clamp(amount, 0.0f, 1.0f);
 			return Lerp(value1, value2, (num * num * (3.0F - 2.0F * num)));
 		}
 
+		//Performs a Catmull-Rom interpolation using the specified positions.
 		static constexpr float CatmullRom(float value1, float value2, float value3, float value4, float amount) {
 			const auto num1 = amount * amount;
 			const auto num2 = amount * num1;
 			return (0.5F * (2.0F * value2 + (-value1 + value3) * amount + (2.0F * value1 - 5.0F * value2 + 4.0F * value3 - value4) * num1 + (-value1 + 3.0F * value2 - 3.0F * value3 + value4) * num2));
 		}
 
+		//Performs a Hermite spline interpolation.
 		static constexpr float Hermite(float value1, float tangent1, float value2, float tangent2, float amount) {
 			const auto num1 = amount;
 			const auto num2 = num1 * num1;