Clarify doc comment

2024-02-21 00:07:38 +01:00
parent 149a6a29f8
commit 97cb8d1b61
2 changed files with 2 additions and 2 deletions
--- a/Source/Engine/Core/Math/Math.h
+++ b/Source/Engine/Core/Math/Math.h
@@ -901,7 +901,7 @@ namespace Math
        return length - Abs(Repeat(t, length * 2.0f) - length);
    }

-    // Rotates position about the given axis by the given angle, in radians, and returns the offset to position
+    // Rotates position about the input axis by the given angle (in radians), and returns the delta to position
    Vector3 FLAXENGINE_API RotateAboutAxis(const Vector3& normalizedRotationAxis, float angle, const Vector3& positionOnAxis, const Vector3& position);

    Vector3 FLAXENGINE_API ExtractLargestComponent(const Vector3& v);