From a421b50be32903bf84ac63ff4a8ac9995d07deed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 26 Feb 2018 19:25:12 +0100 Subject: [PATCH] Math: doc++ --- src/Magnum/Math/Complex.h | 2 +- src/Magnum/Math/DualQuaternion.h | 2 +- src/Magnum/Math/Quaternion.h | 7 ++++--- src/Magnum/Math/Vector.h | 2 +- src/Magnum/Math/Vector2.h | 2 +- src/Magnum/Math/Vector3.h | 2 +- src/Magnum/Math/Vector4.h | 2 +- 7 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/Magnum/Math/Complex.h b/src/Magnum/Math/Complex.h index bffe77edd..21e221e4a 100644 --- a/src/Magnum/Math/Complex.h +++ b/src/Magnum/Math/Complex.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::Complex + * @brief Class @ref Magnum::Math::Complex, function @ref Magnum::Math::dot(), @ref Magnum::math::angle() */ #include diff --git a/src/Magnum/Math/DualQuaternion.h b/src/Magnum/Math/DualQuaternion.h index dd9af612d..859b5fb96 100644 --- a/src/Magnum/Math/DualQuaternion.h +++ b/src/Magnum/Math/DualQuaternion.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::DualQuaternion + * @brief Class @ref Magnum::Math::DualQuaternion, function @ref Magnum::Math::sclerp() */ #include diff --git a/src/Magnum/Math/Quaternion.h b/src/Magnum/Math/Quaternion.h index 1627ad389..306ac0d5b 100644 --- a/src/Magnum/Math/Quaternion.h +++ b/src/Magnum/Math/Quaternion.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::Quaternion + * @brief Class @ref Magnum::Math::Quaternion, function @ref Magnum::Math::dot(), @ref Magnum::Math::angle(), @ref Magnum::Math::lerp(), @ref Magnum::Math::slerp() */ #include @@ -88,7 +88,7 @@ Expects that both quaternions are normalized. @f[ q_{LERP} = \frac{(1 - t) q_A + t q_B}{|(1 - t) q_A + t q_B|} @f] @see @ref Quaternion::isNormalized(), @ref slerp(const Quaternion&, const Quaternion&, T), - @ref lerp(const T&, const T&, U) + @ref lerp(const T&, const T&, U), @ref sclerp() */ template inline Quaternion lerp(const Quaternion& normalizedA, const Quaternion& normalizedB, T t) { CORRADE_ASSERT(normalizedA.isNormalized() && normalizedB.isNormalized(), @@ -108,7 +108,8 @@ or one is a negation of the other, returns the first argument. @f[ ~ ~ ~ ~ ~ ~ ~ \theta = acos \left( \frac{q_A \cdot q_B}{|q_A| \cdot |q_B|} \right) = acos(q_A \cdot q_B) @f] -@see @ref Quaternion::isNormalized(), @ref lerp(const Quaternion&, const Quaternion&, T) +@see @ref Quaternion::isNormalized(), @ref lerp(const Quaternion&, const Quaternion&, T), + @ref sclerp() */ template inline Quaternion slerp(const Quaternion& normalizedA, const Quaternion& normalizedB, T t) { CORRADE_ASSERT(normalizedA.isNormalized() && normalizedB.isNormalized(), diff --git a/src/Magnum/Math/Vector.h b/src/Magnum/Math/Vector.h index 5b351d75a..3527390f0 100644 --- a/src/Magnum/Math/Vector.h +++ b/src/Magnum/Math/Vector.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::Vector + * @brief Class @ref Magnum::Math::Vector, function @ref Magnum::Math::dot(), @ref Magnum::Math::angle() */ #include diff --git a/src/Magnum/Math/Vector2.h b/src/Magnum/Math/Vector2.h index d04adafc8..e1298eb46 100644 --- a/src/Magnum/Math/Vector2.h +++ b/src/Magnum/Math/Vector2.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::Vector2 + * @brief Class @ref Magnum::Math::Vector2, function @ref Magnum::Math::cross() */ #include "Magnum/Math/Vector.h" diff --git a/src/Magnum/Math/Vector3.h b/src/Magnum/Math/Vector3.h index 89d2f2352..a02f6c2d4 100644 --- a/src/Magnum/Math/Vector3.h +++ b/src/Magnum/Math/Vector3.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Math::Vector3 + * @brief Class @ref Magnum::Math::Vector3, function @ref Magnum::Math::cross() */ #include "Magnum/Math/Vector2.h" diff --git a/src/Magnum/Math/Vector4.h b/src/Magnum/Math/Vector4.h index b964bbd3f..129f3ff73 100644 --- a/src/Magnum/Math/Vector4.h +++ b/src/Magnum/Math/Vector4.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Math::Vector4 + * @brief Class @ref Magnum::Math::Vector4 */ #include "Magnum/Math/Vector3.h"