From 5160779e5ef873ffcb7ae545e1153164f8c9cd16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 24 Oct 2015 20:40:39 +0200 Subject: [PATCH] Math: doc++ --- src/Magnum/Math/Dual.h | 4 ++-- src/Magnum/Math/Functions.h | 5 +++-- src/Magnum/Math/Vector.h | 4 ++-- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/Magnum/Math/Dual.h b/src/Magnum/Math/Dual.h index a7d728b63..67e9f29ff 100644 --- a/src/Magnum/Math/Dual.h +++ b/src/Magnum/Math/Dual.h @@ -240,13 +240,13 @@ template Corrade::Utility::Debug& operator<<(Corrade::Utility::Debug& d << value.dual() << Corrade::Utility::Debug::nospace << ")"; } -/** @relates Dual +/** @relatesalso Dual @brief Square root of dual number @f[ \sqrt{\hat a} = \sqrt{a_0} + \epsilon \frac{a_\epsilon}{2 \sqrt{a_0}} @f] -@see @ref Math::sqrt(const T&) +@see @ref sqrt(const T&) */ template Dual sqrt(const Dual& dual) { T sqrt0 = std::sqrt(dual.real()); diff --git a/src/Magnum/Math/Functions.h b/src/Magnum/Math/Functions.h index bd538a283..2062f9af3 100644 --- a/src/Magnum/Math/Functions.h +++ b/src/Magnum/Math/Functions.h @@ -340,7 +340,7 @@ template Vector ceil(const Vector& /** @brief Square root -@see @ref sqrtInverted(), @ref Vector::length() +@see @ref sqrtInverted(), @ref Vector::length(), @ref sqrt(const Dual&) */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline T sqrt(const T& a); @@ -419,7 +419,8 @@ template inline Vector lerpInverted /** @brief Fused multiply-add -Computes and returns @f$ ab + c @f$. +Computes and returns @f$ ab + c @f$. On some architectures might be faster than +doing the computation manually. */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline T fma(const T& a, const T& b, const T& c); diff --git a/src/Magnum/Math/Vector.h b/src/Magnum/Math/Vector.h index c9c29d255..409e112a9 100644 --- a/src/Magnum/Math/Vector.h +++ b/src/Magnum/Math/Vector.h @@ -371,7 +371,7 @@ template class Vector { * @brief Multiply vector with number * * @see @ref operator*(const Vector&) const, - * @ref operator*=(T), operator*(T, const Vector&), + * @ref operator*=(T), @ref operator*(T, const Vector&), * @ref operator*(const Vector&, FloatingPoint) */ Vector operator*(T number) const { @@ -398,7 +398,7 @@ template class Vector { * @brief Divide vector with number * * @see @ref operator/(const Vector&) const, - * @ref operator/=(T), operator/(T, const Vector&), + * @ref operator/=(T), @ref operator/(T, const Vector&), * @ref operator/(const Vector&, FloatingPoint) */ Vector operator/(T number) const {