diff --git a/src/Magnum/Math/Angle.h b/src/Magnum/Math/Angle.h index bbcf0bd3d..156a63718 100644 --- a/src/Magnum/Math/Angle.h +++ b/src/Magnum/Math/Angle.h @@ -163,6 +163,7 @@ template class Deg: public Unit { * Performs conversion from radians to degrees, i.e.: @f[ * deg = 180 \frac {rad} \pi * @f] + * @m_keyword{degrees(),GLSL degrees(),} */ constexpr /*implicit*/ Deg(Unit value); }; @@ -238,6 +239,7 @@ template class Rad: public Unit { * Performs conversion from degrees to radians, i.e.: @f[ * rad = deg \frac \pi 180 * @f] + * @m_keyword{radians(),GLSL radians(),} */ constexpr /*implicit*/ Rad(Unit value); }; diff --git a/src/Magnum/Math/Color.h b/src/Magnum/Math/Color.h index 38d99c1eb..e98367070 100644 --- a/src/Magnum/Math/Color.h +++ b/src/Magnum/Math/Color.h @@ -318,7 +318,7 @@ template class Color3: public Vector3 { typedef std::tuple, FloatingPointType, FloatingPointType> Hsv; #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief Hsv + /** @brief @copybrief Hsv * @deprecated Use @ref Hsv instead. */ typedef CORRADE_DEPRECATED("use Hsv instead") Hsv HSV; @@ -340,13 +340,13 @@ template class Color3: public Vector3 { } #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief fromHsv(const Hsv&) + /** @brief @copybrief fromHsv(const Hsv&) * @deprecated Use @ref fromHsv(const Hsv&) instead. */ CORRADE_DEPRECATED("use fromHsv() instead") static Color3 fromHSV(const Hsv& hsv) { return fromHsv(hsv); } - /** @copybrief fromHsv(Deg, FloatingPointType, FloatingPointType) + /** @brief @copybrief fromHsv(Deg, FloatingPointType, FloatingPointType) * @deprecated Use @ref fromHsv(Deg, FloatingPointType, FloatingPointType) * instead. */ @@ -488,7 +488,7 @@ template class Color3: public Vector3 { } #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief toHsv() + /** @brief @copybrief toHsv() * @deprecated Use @ref toHsv() instead. */ CORRADE_DEPRECATED("use toHsv() instead") Hsv toHSV() const { return toHsv(); } @@ -611,7 +611,7 @@ class Color4: public Vector4 { typedef typename Color3::Hsv Hsv; #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief Hsv + /** @brief @copybrief Hsv * @deprecated Use @ref Hsv instead. */ typedef CORRADE_DEPRECATED("use Hsv instead") Hsv HSV; @@ -696,13 +696,13 @@ class Color4: public Vector4 { } #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief fromHsv(const Hsv&, T) + /** @brief @copybrief fromHsv(const Hsv&, T) * @deprecated Use @ref fromHsv(const Hsv&, T) instead. */ CORRADE_DEPRECATED("use fromHsv() instead") static Color4 fromHSV(const Hsv& hsv, T a = Implementation::fullChannel()) { return fromHsv(hsv, a); } - /** @copybrief fromHsv(Deg, FloatingPointType, FloatingPointType, T) + /** @brief @copybrief fromHsv(Deg, FloatingPointType, FloatingPointType, T) * @deprecated Use @ref fromHsv(Deg, FloatingPointType, FloatingPointType, T) * instead. */ @@ -891,7 +891,7 @@ class Color4: public Vector4 { } #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief toHsv() + /** @brief @copybrief toHsv() * @deprecated Use @ref toHsv() instead. */ CORRADE_DEPRECATED("use toHsv() instead") Hsv toHSV() const { return toHsv(); } diff --git a/src/Magnum/Math/Complex.h b/src/Magnum/Math/Complex.h index 9cb9f896f..566353b35 100644 --- a/src/Magnum/Math/Complex.h +++ b/src/Magnum/Math/Complex.h @@ -90,7 +90,7 @@ template class Complex { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Math::dot(const Complex&, const Complex&) + * @brief @copybrief Math::dot(const Complex&, const Complex&) * @deprecated Use @ref Math::dot(const Complex&, const Complex&) * instead. */ @@ -99,7 +99,7 @@ template class Complex { } /** - * @copybrief Math::angle(const Complex&, const Complex&) + * @brief @copybrief Math::angle(const Complex&, const Complex&) * @deprecated Use @ref Math::angle(const Complex&, const Complex&) * instead. */ diff --git a/src/Magnum/Math/Functions.h b/src/Magnum/Math/Functions.h index b85534a5a..b40d73fab 100644 --- a/src/Magnum/Math/Functions.h +++ b/src/Magnum/Math/Functions.h @@ -517,6 +517,7 @@ template Vector sqrt(const Vector& @brief Inverse square root @see @ref sqrt(), @ref Vector::lengthInverted() +@m_keyword{inversesqrt(),GLSL inversesqrt(),} */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline T sqrtInverted(const T& a); @@ -539,6 +540,7 @@ The interpolation for vectors is done as in following, similarly for scalars: @f \boldsymbol v_{LERP} = (1 - t) \boldsymbol v_A + t \boldsymbol v_B @f] @see @ref lerpInverted(), @ref lerp(const Quaternion&, const Quaternion&, T) +@m_keyword{mix(),GLSL mix(),} */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline T lerp(const T& a, const T& b, U t); @@ -554,6 +556,7 @@ template inline typename std::enable_if inline Vector lerp(const Vector& a, const Vector& b, const BoolVector& t) { Vector out{NoInit}; @@ -562,7 +565,9 @@ template inline Vector lerp(const Vector inline BoolVector lerp(const BoolVector& a, const BoolVector& b, const BoolVector& t) { /* Not using NoInit because it causes some compilers to report unitialized value */ diff --git a/src/Magnum/Math/Math.h b/src/Magnum/Math/Math.h index 6ec34e776..3c17c6e71 100644 --- a/src/Magnum/Math/Math.h +++ b/src/Magnum/Math/Math.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Forward declarations for @ref Magnum::Math namespace + * @brief Forward declarations for the @ref Magnum::Math namespace */ #include diff --git a/src/Magnum/Math/Matrix.h b/src/Magnum/Math/Matrix.h index 3b1e878c4..90b1187c2 100644 --- a/src/Magnum/Math/Matrix.h +++ b/src/Magnum/Math/Matrix.h @@ -186,6 +186,7 @@ template class Matrix: public RectangularMatrix inverted() const; diff --git a/src/Magnum/Math/Matrix4.h b/src/Magnum/Math/Matrix4.h index 565e4e9d7..2d21bc21a 100644 --- a/src/Magnum/Math/Matrix4.h +++ b/src/Magnum/Math/Matrix4.h @@ -347,6 +347,7 @@ template class Matrix4: public Matrix4x4 { * a camera matrix. If you want to get the same what equivalent * call to the well-known `gluLookAt()` would produce, invert the * result using @ref invertedRigid(). + * @m_keywords{gluLookAt()} */ static Matrix4 lookAt(const Vector3& eye, const Vector3& target, const Vector3& up); diff --git a/src/Magnum/Math/Packing.h b/src/Magnum/Math/Packing.h index ea9824a00..e3db308c1 100644 --- a/src/Magnum/Math/Packing.h +++ b/src/Magnum/Math/Packing.h @@ -122,7 +122,7 @@ template CORRADE_DEPRECATED("use unpack() instead") inline FloatingPoint normalize(const Integral& value) { @@ -190,7 +190,7 @@ template CORRADE_DEPRECATED("use pack() instead") inline Integral denormalize(const FloatingPoint& value) { diff --git a/src/Magnum/Math/Quaternion.h b/src/Magnum/Math/Quaternion.h index 0678ad1c4..53837452e 100644 --- a/src/Magnum/Math/Quaternion.h +++ b/src/Magnum/Math/Quaternion.h @@ -138,7 +138,7 @@ template class Quaternion { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Math::dot(const Quaternion&, const Quaternion&) + * @brief @copybrief Math::dot(const Quaternion&, const Quaternion&) * @deprecated Use @ref Math::dot(const Quaternion&, const Quaternion&) * instead. */ @@ -147,7 +147,7 @@ template class Quaternion { } /** - * @copybrief Math::angle(const Quaternion&, const Quaternion&) + * @brief @copybrief Math::angle(const Quaternion&, const Quaternion&) * @deprecated Use @ref Math::angle(const Quaternion&, const Quaternion&) * instead. */ @@ -156,7 +156,7 @@ template class Quaternion { } /** - * @copybrief Math::lerp(const Quaternion&, const Quaternion&, T) + * @brief @copybrief Math::lerp(const Quaternion&, const Quaternion&, T) * @deprecated Use @ref Math::lerp(const Quaternion&, const Quaternion&, T) * instead. */ @@ -165,7 +165,7 @@ template class Quaternion { } /** - * @copybrief Math::slerp(const Quaternion&, const Quaternion&, T) + * @brief @copybrief Math::slerp(const Quaternion&, const Quaternion&, T) * @deprecated Use @ref Math::slerp(const Quaternion&, const Quaternion&, T) * instead. */ diff --git a/src/Magnum/Math/Range.h b/src/Magnum/Math/Range.h index abcb58566..5699e4e84 100644 --- a/src/Magnum/Math/Range.h +++ b/src/Magnum/Math/Range.h @@ -371,7 +371,7 @@ template class Range3D: public Range<3, T> { #endif {} - /** @copybrief Range(NoInitT) */ + /** @brief @copybrief Range(NoInitT) */ explicit Range3D(NoInitT) noexcept /** @todoc remove workaround when doxygen is sane */ #ifndef DOXYGEN_GENERATING_OUTPUT diff --git a/src/Magnum/Math/RectangularMatrix.h b/src/Magnum/Math/RectangularMatrix.h index a54416dac..4ef2c4f44 100644 --- a/src/Magnum/Math/RectangularMatrix.h +++ b/src/Magnum/Math/RectangularMatrix.h @@ -370,6 +370,7 @@ template class RectangularMatrix { * @f[ * (\boldsymbol {AB})_{ji} = \sum_{k=0}^{m-1} \boldsymbol A_{ki} \boldsymbol B_{jk} * @f] + * @m_keyword{outerProduct(),GLSL outerProduct(),} */ template RectangularMatrix operator*(const RectangularMatrix& other) const; @@ -392,6 +393,7 @@ template class RectangularMatrix { * \boldsymbol{A}^T_ij = \boldsymbol{A}_ji * @f] * @see @ref row(), @ref flippedCols(), @ref flippedRows() + * @m_keyword{transpose(),GLSL transpose(),} */ RectangularMatrix transposed() const; diff --git a/src/Magnum/Math/Vector.h b/src/Magnum/Math/Vector.h index d6273dc3c..bd62bfbd1 100644 --- a/src/Magnum/Math/Vector.h +++ b/src/Magnum/Math/Vector.h @@ -150,7 +150,7 @@ template class Vector { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Math::dot(const Vector&, const Vector&) + * @brief @copybrief Magnum::Math::dot(const Vector&, const Vector&) * @deprecated Use @ref Math::dot(const Vector&, const Vector&) * instead. */ @@ -159,7 +159,7 @@ template class Vector { } /** - * @copybrief Math::angle(const Vector&, const Vector&) + * @brief @copybrief Magnum::Math::angle(const Vector&, const Vector&) * @deprecated Use @ref Math::angle(const Vector&, const Vector&) * instead. */ @@ -249,16 +249,32 @@ template class Vector { return !operator==(other); } - /** @brief Component-wise less than */ + /** + * @brief Component-wise less than + * + * @m_keyword{lessThan(),GLSL lessThan(),} + */ BoolVector operator<(const Vector& other) const; - /** @brief Component-wise less than or equal */ + /** + * @brief Component-wise less than or equal + * + * @m_keyword{lessThanEqual(),GLSL lessThanEqual(),} + */ BoolVector operator<=(const Vector& other) const; - /** @brief Component-wise greater than or equal */ + /** + * @brief Component-wise greater than or equal + * + * @m_keyword{greaterThanEqual(),GLSL greaterThanEqual(),} + */ BoolVector operator>=(const Vector& other) const; - /** @brief Component-wise greater than */ + /** + * @brief Component-wise greater than + * + * @m_keyword{greaterThan(),GLSL greaterThan(),} + */ BoolVector operator>(const Vector& other) const; /** @@ -488,6 +504,7 @@ template class Vector { * @brief Normalized vector (of unit length) * * @see @ref isNormalized(), @ref lengthInverted(), @ref resized() + * @m_keyword{normalize(),GLSL normalize(),} */ Vector normalized() const { return *this*lengthInverted(); } diff --git a/src/Magnum/Math/Vector2.h b/src/Magnum/Math/Vector2.h index 45657bd11..1971fc0c6 100644 --- a/src/Magnum/Math/Vector2.h +++ b/src/Magnum/Math/Vector2.h @@ -106,7 +106,7 @@ template class Vector2: public Vector<2, T> { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Math::cross(const Vector2&, const Vector2&) + * @brief @copybrief Math::cross(const Vector2&, const Vector2&) * @deprecated Use @ref Math::cross(const Vector2&, const Vector2&) * instead. */ diff --git a/src/Magnum/Math/Vector3.h b/src/Magnum/Math/Vector3.h index 14882f695..cdd563033 100644 --- a/src/Magnum/Math/Vector3.h +++ b/src/Magnum/Math/Vector3.h @@ -128,7 +128,7 @@ template class Vector3: public Vector<3, T> { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Math::cross(const Vector3&, const Vector3&) + * @brief @copybrief Math::cross(const Vector3&, const Vector3&) * @deprecated Use @ref Math::cross(const Vector3&, const Vector3&) * instead. */