diff --git a/doc/changelog-old.dox b/doc/changelog-old.dox index 1282fe35d..b721cfd2b 100644 --- a/doc/changelog-old.dox +++ b/doc/changelog-old.dox @@ -73,9 +73,9 @@ Released 2018-05-01, tagged as APIs, separated from the core Magnum library (see [mosra/magnum#233](https://github.com/mosra/magnum/pull/233)) - New @ref GL::hasPixelFormat(), @ref GL::pixelFormat(), @ref GL::pixelType(), - @ref GL::hasCompressedPixelFormat(), @ref compressedPixelFormat() utilities - for converting generic @ref PixelFormat / @ref CompressedPixelFormat to - GL-specific @ref GL::PixelFormat, @ref GL::PixelType and + @ref GL::hasCompressedPixelFormat(), @ref GL::compressedPixelFormat() + utilities for converting generic @ref PixelFormat / @ref CompressedPixelFormat + to GL-specific @ref GL::PixelFormat, @ref GL::PixelType and @ref GL::CompressedPixelFormat values. The @ref GL::BufferImage and @ref GL::CompressedBufferImage classes now have overloads accepting both types. @@ -416,9 +416,9 @@ Released 2018-05-01, tagged as in 2015.05, use methods on linked list returned by @ref Platform::BasicScreenedApplication::screens() "Platform::ScreenedApplication::screens()" instead -- Removed @ref Framebuffer::read() "*Framebuffer::read()" functions taking two - vectors that was deprecated in 2015.05, use overload taking @ref Range2Di - instead +- Removed @ref GL::Framebuffer::read() "*Framebuffer::read()" functions + taking two vectors that was deprecated in 2015.05, use overload taking + @ref Range2Di instead - Removed the @cpp Mesh::maxVertexAttributes() @ce function that was deprecated in 2015.05, use @ref GL::AbstractShaderProgram::maxVertexAttributes() instead @@ -681,7 +681,7 @@ a high-level overview. - New @ref Math::Bezier class for handling N-dimensional M-order Bézier curves (see [mosra/magnum#165](https://github.com/mosra/magnum/pull/165)) -- New @ref Math::Frustum class and @ref Math::Geometry::Intersection::pointFrustum(), +- New @ref Math::Frustum class and `Math::Geometry::Intersection::pointFrustum()`, `Math::Geometry::Intersection::boxFrustum()` functions (see [mosra/magnum#185](https://github.com/mosra/magnum/pull/185) - New @ref Math::Half class, @link Math::Literals::HalfLiterals::operator""_h @endlink @@ -1132,7 +1132,7 @@ a high-level overview. are now a namespace (might break `using` declarations, but otherwise it's fully source-compatible) - Removed `Context::majorVersion()` and `Context::minorVersion()` functions, - use @ref Context::version() instead + use @ref GL::Context::version() instead - Removed deprecated `Magnum/DebugMarker.h` header, use `Magnum/DebugOutput.h` and @ref GL::DebugMessage "DebugMessage" class instead @@ -1882,7 +1882,7 @@ for a high-level overview. into @cpp Math::swizzle() @ce - @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce overloads taking pair of data pointer and size are deprecated, use - @cpp Containers::ArrayReference @ce-based @cpp Buffer::setData() @ce and + @cpp Containers::ArrayReference @ce -based @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce - `ImageFormat.h` header, @cpp ImageFormat @ce and @cpp ImageType @ce enums are deprecated, use `ColorFormat.h` header, `ColorFormat` and `ColorType` diff --git a/doc/changelog.dox b/doc/changelog.dox index 34877dc01..baea0602d 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -2233,7 +2233,7 @@ Released 2020-06-27, tagged as now fall back to linear interpolation when the quaternions are close to each other, instead of unconditionally returning the first argument - Added non-const overloads to @ref Math::Frustum::operator[]() and - @ref Math::Frustum::front() etc. accessors, returning references (see + @ref Math::Frustum::near() etc. accessors, returning references (see [mosra/magnum#425](https://github.com/mosra/magnum/pull/425)) @subsubsection changelog-2020-06-changes-meshtools MeshTools library diff --git a/doc/matrix-vector.dox b/doc/matrix-vector.dox index b19b7bfad..e063b94fb 100644 --- a/doc/matrix-vector.dox +++ b/doc/matrix-vector.dox @@ -119,17 +119,17 @@ representation, or convert from CIE XYZ / xyY. And the other way as well: @snippet Math.cpp matrix-vector-construct-color-colorspace Finally, the namespace @ref Math::Literals provides convenient -@link Literals::operator""_rgb() operator""_rgb() @endlink / -@link Literals::operator""_rgbf() operator""_rgbf() @endlink and -@link Literals::operator""_rgba() operator""_rgba() @endlink / -@link Literals::operator""_rgbaf() operator""_rgbaf() @endlink literals for -entering colors in hex representation. These literals assume linear RGB input -and don't do any gamma correction. For sRGB input, there is -@link Literals::operator""_srgb() operator""_srgb() @endlink / -@link Literals::operator""_srgba() operator""_srgba() @endlink and -@link Literals::operator""_srgbf() operator""_srgbf() @endlink / -@link Literals::operator""_srgbaf() operator""_srgbaf() @endlink, see their -documentation for more information. +@link Math::Literals::ColorLiterals::operator""_rgb() operator""_rgb() @endlink +/ @link Math::Literals::ColorLiterals::operator""_rgbf() operator""_rgbf() @endlink +and @link Math::Literals::ColorLiterals::operator""_rgba() operator""_rgba() @endlink +/ @link Math::Literals::ColorLiterals::operator""_rgbaf() operator""_rgbaf() @endlink +literals for entering colors in hex representation. These literals assume +linear RGB input and don't do any gamma correction. For sRGB input, there is +@link Math::Literals::ColorLiterals::operator""_srgb() operator""_srgb() @endlink +/ @link Math::Literals::ColorLiterals::operator""_srgba() operator""_srgba() @endlink +and @link Math::Literals::ColorLiterals::operator""_srgbf() operator""_srgbf() @endlink +/ @link Math::Literals::ColorLiterals::operator""_srgbaf() operator""_srgbaf() @endlink, +see their documentation for more information. @snippet Math.cpp matrix-vector-construct-color-literal @@ -223,7 +223,7 @@ a vector you can use @ref Math::Vector::sum() "sum()" and Component-wise minimum and maximum of two vectors can be done using @ref Math::min(), @ref Math::max() or @ref Math::minmax(), similarly with -@ref Vector::min() "min()", @ref Vector::max() "max()" and +@ref Math::Vector::min() "min()", @ref Math::Vector::max() "max()" and @ref Vector2::minmax() "minmax()" for components in one vector. @snippet Math.cpp matrix-vector-operations-minmax @@ -288,8 +288,8 @@ you're used to from linear algebra or other graphics toolkits: @snippet Math.cpp matrix-vector-column-major-access
  • Various algorithms which commonly operate on matrix rows (such as - @ref Algorithms::gaussJordanInPlace() "Gauss-Jordan elimination") have - faster alternatives which operate on columns. It's then up to the user + @ref Math::Algorithms::gaussJordanInPlace() "Gauss-Jordan elimination") + have faster alternatives which operate on columns. It's then up to the user to operate with transposed matrices or use the slower non-transposed alternative of the algorithm.
  • diff --git a/src/Magnum/MaterialTools/Filter.h b/src/Magnum/MaterialTools/Filter.h index a02608be7..a3fdaf562 100644 --- a/src/Magnum/MaterialTools/Filter.h +++ b/src/Magnum/MaterialTools/Filter.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Function @ref Magnum::MaterialTools::filterAttributes(), @ref Magnum::MaterialTools::filterLayers(), @ref filterAttributesLayers() + * @brief Function @ref Magnum::MaterialTools::filterAttributes(), @ref Magnum::MaterialTools::filterLayers(), @ref Magnum::MaterialTools::filterAttributesLayers() * @m_since_latest */ diff --git a/src/Magnum/Math/Distance.h b/src/Magnum/Math/Distance.h index 79a2d3791..f98a5f77b 100644 --- a/src/Magnum/Math/Distance.h +++ b/src/Magnum/Math/Distance.h @@ -45,7 +45,7 @@ namespace Magnum { namespace Math { namespace Distance { Same as @cpp (b - a).dot() @ce. More efficient than @ref pointPoint(const Vector2&, const Vector2&) for comparing distance with other values, because it doesn't calculate the square root. -@see @ref Vector::dot() +@see @ref Vector::dot() const */ template T pointPointSquared(const Vector2& a, const Vector2& b) { return (b - a).dot(); diff --git a/src/Magnum/Math/Intersection.h b/src/Magnum/Math/Intersection.h index cd4ac081f..eee724c8c 100644 --- a/src/Magnum/Math/Intersection.h +++ b/src/Magnum/Math/Intersection.h @@ -63,7 +63,7 @@ point @f$ \boldsymbol{p} @f$ intersects with a circle of a center \end{array} @f] -@see @ref Distance::pointPointSquared(), @ref Vector::dot(), @ref pow(T) +@see @ref Distance::pointPointSquared(), @ref Vector::dot() const, @ref pow(T) */ template inline bool pointCircle(const Vector2& point, const Vector2& circleCenter, T circleRadius) { return (circleCenter - point).dot() <= circleRadius*circleRadius; @@ -87,7 +87,7 @@ point @f$ \boldsymbol{p} @f$ intersects with a sphere of a center \end{array} @f] -@see @ref Distance::pointPointSquared(), @ref Vector::dot(), @ref pow(T), +@see @ref Distance::pointPointSquared(), @ref Vector::dot() const, @ref pow(T), @see @ref MeshTools::boundingSphereBouncingBubble() */ template inline bool pointSphere(const Vector3& point, const Vector3& sphereCenter, T sphereRadius) { diff --git a/src/Magnum/Math/Matrix3.h b/src/Magnum/Math/Matrix3.h index 2cf4ebcb3..353b108b3 100644 --- a/src/Magnum/Math/Matrix3.h +++ b/src/Magnum/Math/Matrix3.h @@ -147,7 +147,7 @@ template class Matrix3: public Matrix3x3 { * @f] * @see @ref rotation() const, @ref Complex::rotation(), * @ref DualComplex::rotation(), - * @ref Matrix4::rotation(Rad, const Vector3&) + * @ref Matrix4::rotation(Rad, const Vector3&) */ static Matrix3 rotation(Rad angle); diff --git a/src/Magnum/Math/Matrix4.h b/src/Magnum/Math/Matrix4.h index 1dc3d2eec..2da450515 100644 --- a/src/Magnum/Math/Matrix4.h +++ b/src/Magnum/Math/Matrix4.h @@ -178,7 +178,7 @@ template class Matrix4: public Matrix4x4 { * \end{pmatrix} * @f] * @see @ref rotation() const, @ref Quaternion::rotation(), - * @ref DualQuaternion::rotation(), @ref Matrix3::rotation(Rad), + * @ref DualQuaternion::rotation(), @ref Matrix3::rotation(Rad), * @ref Vector3::xAxis(), @ref Vector3::yAxis(), * @ref Vector3::zAxis(), @ref Vector::isNormalized() */ @@ -196,9 +196,9 @@ template class Matrix4: public Matrix4x4 { * 0 & 0 & 0 & 1 * \end{pmatrix} * @f] - * @see @ref rotation(Rad, const Vector3&), @ref rotationY(), + * @see @ref rotation(Rad, const Vector3&), @ref rotationY(), * @ref rotationZ(), @ref rotation() const, - * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) + * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) */ static Matrix4 rotationX(Rad angle); @@ -214,9 +214,9 @@ template class Matrix4: public Matrix4x4 { * 0 & 0 & 0 & 1 * \end{pmatrix} * @f] - * @see @ref rotation(Rad, const Vector3&), @ref rotationX(), + * @see @ref rotation(Rad, const Vector3&), @ref rotationX(), * @ref rotationZ(), @ref rotation() const, - * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) + * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) */ static Matrix4 rotationY(Rad angle); @@ -232,9 +232,9 @@ template class Matrix4: public Matrix4x4 { * 0 & 0 & 0 & 1 * \end{pmatrix} * @f] - * @see @ref rotation(Rad, const Vector3&), @ref rotationX(), + * @see @ref rotation(Rad, const Vector3&), @ref rotationX(), * @ref rotationY(), @ref rotation() const, - * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) + * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) */ static Matrix4 rotationZ(Rad angle); diff --git a/src/Magnum/MeshTools/BoundingVolume.h b/src/Magnum/MeshTools/BoundingVolume.h index dc6dcbf82..07297645d 100644 --- a/src/Magnum/MeshTools/BoundingVolume.h +++ b/src/Magnum/MeshTools/BoundingVolume.h @@ -42,7 +42,7 @@ namespace Magnum { namespace MeshTools { @return Bounding range @m_since_latest -Same as @ref Math::minmax(const Corrade::Containers::StridedArrayView1D&). +Same as @ref Math::minmax(const Containers::StridedArrayView1D&). @see @ref Math::Intersection::rayRange(), @ref Math::Intersection::rangeFrustum(), @ref Math::Intersection::rangeCone() diff --git a/src/Magnum/Platform/AbstractXApplication.h b/src/Magnum/Platform/AbstractXApplication.h index b35caa5c9..3a171a64f 100644 --- a/src/Magnum/Platform/AbstractXApplication.h +++ b/src/Magnum/Platform/AbstractXApplication.h @@ -382,7 +382,7 @@ class AbstractXApplication::GLConfiguration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index 2c20b326e..ea98528a1 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -488,7 +488,7 @@ class AndroidApplication::GLConfiguration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index 10b677f15..accb7950c 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -200,7 +200,7 @@ class WindowlessCglContext::Configuration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index 9b7114537..739f9be9c 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -258,7 +258,7 @@ class WindowlessEglContext::Configuration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 9b84aa582..5af9aeb0d 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -253,7 +253,7 @@ class WindowlessGlxContext::Configuration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/WindowlessIosApplication.h b/src/Magnum/Platform/WindowlessIosApplication.h index d12a0feea..b86686a2e 100644 --- a/src/Magnum/Platform/WindowlessIosApplication.h +++ b/src/Magnum/Platform/WindowlessIosApplication.h @@ -191,7 +191,7 @@ class WindowlessIosContext::Configuration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index 31314dcf7..35cf2514c 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -240,7 +240,7 @@ class WindowlessWglContext::Configuration: public GL::Context::Configuration { /** * @brief Context flags * - * @see @ref setFlags(), @ref Context::Flags + * @see @ref setFlags(), @ref GL::Context::Flags */ typedef Containers::EnumSet Flags; diff --git a/src/Magnum/TextureTools/Atlas.h b/src/Magnum/TextureTools/Atlas.h index abf65f0f8..92ddb30eb 100644 --- a/src/Magnum/TextureTools/Atlas.h +++ b/src/Magnum/TextureTools/Atlas.h @@ -104,7 +104,7 @@ MAGNUM_TEXTURETOOLS_EXPORT Debug& operator<<(Debug& output, AtlasLandfillFlag va @brief Landfill texture atlas packer behavior flags @m_since_latest -@see @ref Flags, @ref AtlasLandfill::setFlags(), @ref AtlasLandfill::addFlags(), +@see @ref AtlasLandfill::setFlags(), @ref AtlasLandfill::addFlags(), @ref AtlasLandfill::clearFlags() */ typedef Containers::EnumSet AtlasLandfillFlags; diff --git a/src/Magnum/Trade/SceneData.h b/src/Magnum/Trade/SceneData.h index f0aa0f598..ff764c824 100644 --- a/src/Magnum/Trade/SceneData.h +++ b/src/Magnum/Trade/SceneData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Trade::SceneData, @ref Magnum::Trade::SceneFieldData, enum @ref Magnum::Trade::SceneMappingType, @ref Magnum::Trade::SceneField, @ref Magnum::Trade::SceneFieldType, @ref Magnum::Trade::SceneFieldFlag, enum set @ref Magnum::Trade::SceneFieldFlags, function @ref Magnum::sceneMappingTypeSize(), @ref Magnum::sceneMappingTypeAlignment(), @ref Magnum::sceneFieldTypeSize(), @ref Magnum::sceneFieldTypeAlignment(), @ref Magnum::Trade::isSceneFieldCustom(), @ref Magnum::sceneFieldCustom() + * @brief Class @ref Magnum::Trade::SceneData, @ref Magnum::Trade::SceneFieldData, enum @ref Magnum::Trade::SceneMappingType, @ref Magnum::Trade::SceneField, @ref Magnum::Trade::SceneFieldType, @ref Magnum::Trade::SceneFieldFlag, enum set @ref Magnum::Trade::SceneFieldFlags, function @ref Magnum::Trade::sceneMappingTypeSize(), @ref Magnum::Trade::sceneMappingTypeAlignment(), @ref Magnum::Trade::sceneFieldTypeSize(), @ref Magnum::Trade::sceneFieldTypeAlignment(), @ref Magnum::Trade::isSceneFieldCustom(), @ref Magnum::Trade::sceneFieldCustom() */ #include diff --git a/src/Magnum/Vk/ExtensionProperties.h b/src/Magnum/Vk/ExtensionProperties.h index c25f25788..d108f3d94 100644 --- a/src/Magnum/Vk/ExtensionProperties.h +++ b/src/Magnum/Vk/ExtensionProperties.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class @ref Magnum::Vk::ExtensionProperties, @ref Magnum::Vk::InstanceExtensionProperties, function @ref enumerateInstanceExtensionProperties() + * @brief Class @ref Magnum::Vk::ExtensionProperties, @ref Magnum::Vk::InstanceExtensionProperties, function @ref Magnum::Vk::enumerateInstanceExtensionProperties() * @m_since_latest */