From 33ee4c5e8a7a104c76713b84afc44ce4ed4d7b94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 26 Apr 2025 17:16:12 +0200 Subject: [PATCH] Math: doc++ Improve related links for the literals, and don't say "calls" because it doesn't do that anymore, and it'd imply it inherits the same issues with not checking for hexadecimal colors or not checking length. --- src/Magnum/Math/Color.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/Magnum/Math/Color.h b/src/Magnum/Math/Color.h index 1a14f78b8..3158c39e5 100644 --- a/src/Magnum/Math/Color.h +++ b/src/Magnum/Math/Color.h @@ -1527,7 +1527,7 @@ RGB. Use this literal to document that given value is in sRGB. Example usage: representation directly or convert the value using @ref Color3::fromSrgb() / @ref Color3::fromSrgbInt(). -@see @link operator""_srgba() @endlink, @link operator""_rgb() @endlink +@see @link operator""_srgba() @endlink, @link operator""_srgbf() @endlink @m_keywords{_srgb srgb} */ /* Output is a Vector3 to hint that it doesn't have any (additive, @@ -1573,7 +1573,7 @@ usage: representation directly or convert the value using @ref Color4::fromSrgbAlpha() / @ref Color4::fromSrgbAlphaInt(). -@see @link operator""_srgb() @endlink, @link operator""_rgba() @endlink +@see @link operator""_srgb() @endlink, @link operator""_rgbaf() @endlink @m_keywords{_srgba srgba} */ /* Output is a Vector3 to hint that it doesn't have any (additive, @@ -1605,7 +1605,8 @@ template constexpr Color3 operator"" _rgbf() { /** @relatesalso Magnum::Math::Color3 @brief Float sRGB literal -Calls @ref Color3::fromSrgbInt() on the literal value. Example usage: +Equivalent to calling @ref Color3::fromSrgbInt() on the literal value. Example +usage: @snippet Math.cpp _srgbf @@ -1640,7 +1641,8 @@ template constexpr Color4 operator"" _rgbaf() { /** @relatesalso Magnum::Math::Color4 @brief Float sRGB + alpha literal -Calls @ref Color4::fromSrgbAlphaInt() on the literal value. Example usage: +Equivalent to calling @ref Color4::fromSrgbAlphaInt() on the literal value. +Example usage: @snippet Math.cpp _srgbaf