Browse Source

doc: fix various errors in Doxygen references.

Those were all accepted by 1.8.16, but 1.12 is more strict (which is
good!), so I'm fixing them.
pull/650/head
Vladimír Vondruš 2 years ago
parent
commit
dc9897ff1e
  1. 18
      doc/changelog-old.dox
  2. 2
      doc/changelog.dox
  3. 28
      doc/matrix-vector.dox
  4. 2
      src/Magnum/MaterialTools/Filter.h
  5. 2
      src/Magnum/Math/Distance.h
  6. 4
      src/Magnum/Math/Intersection.h
  7. 2
      src/Magnum/Math/Matrix3.h
  8. 14
      src/Magnum/Math/Matrix4.h
  9. 2
      src/Magnum/MeshTools/BoundingVolume.h
  10. 2
      src/Magnum/Platform/AbstractXApplication.h
  11. 2
      src/Magnum/Platform/AndroidApplication.h
  12. 2
      src/Magnum/Platform/WindowlessCglApplication.h
  13. 2
      src/Magnum/Platform/WindowlessEglApplication.h
  14. 2
      src/Magnum/Platform/WindowlessGlxApplication.h
  15. 2
      src/Magnum/Platform/WindowlessIosApplication.h
  16. 2
      src/Magnum/Platform/WindowlessWglApplication.h
  17. 2
      src/Magnum/TextureTools/Atlas.h
  18. 2
      src/Magnum/Trade/SceneData.h
  19. 2
      src/Magnum/Vk/ExtensionProperties.h

18
doc/changelog-old.dox

@ -73,9 +73,9 @@ Released 2018-05-01, tagged as
APIs, separated from the core Magnum library (see APIs, separated from the core Magnum library (see
[mosra/magnum#233](https://github.com/mosra/magnum/pull/233)) [mosra/magnum#233](https://github.com/mosra/magnum/pull/233))
- New @ref GL::hasPixelFormat(), @ref GL::pixelFormat(), @ref GL::pixelType(), - New @ref GL::hasPixelFormat(), @ref GL::pixelFormat(), @ref GL::pixelType(),
@ref GL::hasCompressedPixelFormat(), @ref compressedPixelFormat() utilities @ref GL::hasCompressedPixelFormat(), @ref GL::compressedPixelFormat()
for converting generic @ref PixelFormat / @ref CompressedPixelFormat to utilities for converting generic @ref PixelFormat / @ref CompressedPixelFormat
GL-specific @ref GL::PixelFormat, @ref GL::PixelType and to GL-specific @ref GL::PixelFormat, @ref GL::PixelType and
@ref GL::CompressedPixelFormat values. The @ref GL::BufferImage and @ref GL::CompressedPixelFormat values. The @ref GL::BufferImage and
@ref GL::CompressedBufferImage classes now have overloads accepting both @ref GL::CompressedBufferImage classes now have overloads accepting both
types. types.
@ -416,9 +416,9 @@ Released 2018-05-01, tagged as
in 2015.05, use methods on linked list returned by in 2015.05, use methods on linked list returned by
@ref Platform::BasicScreenedApplication::screens() "Platform::ScreenedApplication::screens()" @ref Platform::BasicScreenedApplication::screens() "Platform::ScreenedApplication::screens()"
instead instead
- Removed @ref Framebuffer::read() "*Framebuffer::read()" functions taking two - Removed @ref GL::Framebuffer::read() "*Framebuffer::read()" functions
vectors that was deprecated in 2015.05, use overload taking @ref Range2Di taking two vectors that was deprecated in 2015.05, use overload taking
instead @ref Range2Di instead
- Removed the @cpp Mesh::maxVertexAttributes() @ce function that was - Removed the @cpp Mesh::maxVertexAttributes() @ce function that was
deprecated in 2015.05, use @ref GL::AbstractShaderProgram::maxVertexAttributes() deprecated in 2015.05, use @ref GL::AbstractShaderProgram::maxVertexAttributes()
instead instead
@ -681,7 +681,7 @@ a high-level overview.
- New @ref Math::Bezier class for handling N-dimensional M-order Bézier - 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)) 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 `Math::Geometry::Intersection::boxFrustum()` functions (see
[mosra/magnum#185](https://github.com/mosra/magnum/pull/185) [mosra/magnum#185](https://github.com/mosra/magnum/pull/185)
- New @ref Math::Half class, @link Math::Literals::HalfLiterals::operator""_h @endlink - 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 are now a namespace (might break `using` declarations, but otherwise it's
fully source-compatible) fully source-compatible)
- Removed `Context::majorVersion()` and `Context::minorVersion()` functions, - 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 - Removed deprecated `Magnum/DebugMarker.h` header, use
`Magnum/DebugOutput.h` and @ref GL::DebugMessage "DebugMessage" class `Magnum/DebugOutput.h` and @ref GL::DebugMessage "DebugMessage" class
instead instead
@ -1882,7 +1882,7 @@ for a high-level overview.
into @cpp Math::swizzle() @ce into @cpp Math::swizzle() @ce
- @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce overloads - @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce overloads
taking pair of data pointer and size are deprecated, use 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 @cpp Buffer::setSubData() @ce
- `ImageFormat.h` header, @cpp ImageFormat @ce and @cpp ImageType @ce enums - `ImageFormat.h` header, @cpp ImageFormat @ce and @cpp ImageType @ce enums
are deprecated, use `ColorFormat.h` header, `ColorFormat` and `ColorType` are deprecated, use `ColorFormat.h` header, `ColorFormat` and `ColorType`

2
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 now fall back to linear interpolation when the quaternions are close to
each other, instead of unconditionally returning the first argument each other, instead of unconditionally returning the first argument
- Added non-const overloads to @ref Math::Frustum::operator[]() and - 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)) [mosra/magnum#425](https://github.com/mosra/magnum/pull/425))
@subsubsection changelog-2020-06-changes-meshtools MeshTools library @subsubsection changelog-2020-06-changes-meshtools MeshTools library

28
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 @snippet Math.cpp matrix-vector-construct-color-colorspace
Finally, the namespace @ref Math::Literals provides convenient Finally, the namespace @ref Math::Literals provides convenient
@link Literals::operator""_rgb() operator""_rgb() @endlink / @link Math::Literals::ColorLiterals::operator""_rgb() operator""_rgb() @endlink
@link Literals::operator""_rgbf() operator""_rgbf() @endlink and / @link Math::Literals::ColorLiterals::operator""_rgbf() operator""_rgbf() @endlink
@link Literals::operator""_rgba() operator""_rgba() @endlink / and @link Math::Literals::ColorLiterals::operator""_rgba() operator""_rgba() @endlink
@link Literals::operator""_rgbaf() operator""_rgbaf() @endlink literals for / @link Math::Literals::ColorLiterals::operator""_rgbaf() operator""_rgbaf() @endlink
entering colors in hex representation. These literals assume linear RGB input literals for entering colors in hex representation. These literals assume
and don't do any gamma correction. For sRGB input, there is linear RGB input and don't do any gamma correction. For sRGB input, there is
@link Literals::operator""_srgb() operator""_srgb() @endlink / @link Math::Literals::ColorLiterals::operator""_srgb() operator""_srgb() @endlink
@link Literals::operator""_srgba() operator""_srgba() @endlink and / @link Math::Literals::ColorLiterals::operator""_srgba() operator""_srgba() @endlink
@link Literals::operator""_srgbf() operator""_srgbf() @endlink / and @link Math::Literals::ColorLiterals::operator""_srgbf() operator""_srgbf() @endlink
@link Literals::operator""_srgbaf() operator""_srgbaf() @endlink, see their / @link Math::Literals::ColorLiterals::operator""_srgbaf() operator""_srgbaf() @endlink,
documentation for more information. see their documentation for more information.
@snippet Math.cpp matrix-vector-construct-color-literal @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 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 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. @ref Vector2::minmax() "minmax()" for components in one vector.
@snippet Math.cpp matrix-vector-operations-minmax @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 @snippet Math.cpp matrix-vector-column-major-access
</li><li> </li><li>
Various algorithms which commonly operate on matrix rows (such as Various algorithms which commonly operate on matrix rows (such as
@ref Algorithms::gaussJordanInPlace() "Gauss-Jordan elimination") have @ref Math::Algorithms::gaussJordanInPlace() "Gauss-Jordan elimination")
faster alternatives which operate on columns. It's then up to the user 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 to operate with transposed matrices or use the slower non-transposed
alternative of the algorithm. alternative of the algorithm.
</li></ul> </li></ul>

2
src/Magnum/MaterialTools/Filter.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @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 * @m_since_latest
*/ */

2
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<T>&, const Vector2<T>&) Same as @cpp (b - a).dot() @ce. More efficient than @ref pointPoint(const Vector2<T>&, const Vector2<T>&)
for comparing distance with other values, because it doesn't calculate the for comparing distance with other values, because it doesn't calculate the
square root. square root.
@see @ref Vector::dot() @see @ref Vector::dot() const
*/ */
template<class T> T pointPointSquared(const Vector2<T>& a, const Vector2<T>& b) { template<class T> T pointPointSquared(const Vector2<T>& a, const Vector2<T>& b) {
return (b - a).dot(); return (b - a).dot();

4
src/Magnum/Math/Intersection.h

@ -63,7 +63,7 @@ point @f$ \boldsymbol{p} @f$ intersects with a circle of a center
\end{array} \end{array}
@f] @f]
@see @ref Distance::pointPointSquared(), @ref Vector::dot(), @ref pow(T) @see @ref Distance::pointPointSquared(), @ref Vector::dot() const, @ref pow(T)
*/ */
template<class T> inline bool pointCircle(const Vector2<T>& point, const Vector2<T>& circleCenter, T circleRadius) { template<class T> inline bool pointCircle(const Vector2<T>& point, const Vector2<T>& circleCenter, T circleRadius) {
return (circleCenter - point).dot() <= circleRadius*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} \end{array}
@f] @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() @see @ref MeshTools::boundingSphereBouncingBubble()
*/ */
template<class T> inline bool pointSphere(const Vector3<T>& point, const Vector3<T>& sphereCenter, T sphereRadius) { template<class T> inline bool pointSphere(const Vector3<T>& point, const Vector3<T>& sphereCenter, T sphereRadius) {

2
src/Magnum/Math/Matrix3.h

@ -147,7 +147,7 @@ template<class T> class Matrix3: public Matrix3x3<T> {
* @f] * @f]
* @see @ref rotation() const, @ref Complex::rotation(), * @see @ref rotation() const, @ref Complex::rotation(),
* @ref DualComplex::rotation(), * @ref DualComplex::rotation(),
* @ref Matrix4::rotation(Rad, const Vector3<T>&) * @ref Matrix4::rotation(Rad<T>, const Vector3<T>&)
*/ */
static Matrix3<T> rotation(Rad<T> angle); static Matrix3<T> rotation(Rad<T> angle);

14
src/Magnum/Math/Matrix4.h

@ -178,7 +178,7 @@ template<class T> class Matrix4: public Matrix4x4<T> {
* \end{pmatrix} * \end{pmatrix}
* @f] * @f]
* @see @ref rotation() const, @ref Quaternion::rotation(), * @see @ref rotation() const, @ref Quaternion::rotation(),
* @ref DualQuaternion::rotation(), @ref Matrix3::rotation(Rad), * @ref DualQuaternion::rotation(), @ref Matrix3::rotation(Rad<T>),
* @ref Vector3::xAxis(), @ref Vector3::yAxis(), * @ref Vector3::xAxis(), @ref Vector3::yAxis(),
* @ref Vector3::zAxis(), @ref Vector::isNormalized() * @ref Vector3::zAxis(), @ref Vector::isNormalized()
*/ */
@ -196,9 +196,9 @@ template<class T> class Matrix4: public Matrix4x4<T> {
* 0 & 0 & 0 & 1 * 0 & 0 & 0 & 1
* \end{pmatrix} * \end{pmatrix}
* @f] * @f]
* @see @ref rotation(Rad, const Vector3<T>&), @ref rotationY(), * @see @ref rotation(Rad<T>, const Vector3<T>&), @ref rotationY(),
* @ref rotationZ(), @ref rotation() const, * @ref rotationZ(), @ref rotation() const,
* @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad<T>)
*/ */
static Matrix4<T> rotationX(Rad<T> angle); static Matrix4<T> rotationX(Rad<T> angle);
@ -214,9 +214,9 @@ template<class T> class Matrix4: public Matrix4x4<T> {
* 0 & 0 & 0 & 1 * 0 & 0 & 0 & 1
* \end{pmatrix} * \end{pmatrix}
* @f] * @f]
* @see @ref rotation(Rad, const Vector3<T>&), @ref rotationX(), * @see @ref rotation(Rad<T>, const Vector3<T>&), @ref rotationX(),
* @ref rotationZ(), @ref rotation() const, * @ref rotationZ(), @ref rotation() const,
* @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad<T>)
*/ */
static Matrix4<T> rotationY(Rad<T> angle); static Matrix4<T> rotationY(Rad<T> angle);
@ -232,9 +232,9 @@ template<class T> class Matrix4: public Matrix4x4<T> {
* 0 & 0 & 0 & 1 * 0 & 0 & 0 & 1
* \end{pmatrix} * \end{pmatrix}
* @f] * @f]
* @see @ref rotation(Rad, const Vector3<T>&), @ref rotationX(), * @see @ref rotation(Rad<T>, const Vector3<T>&), @ref rotationX(),
* @ref rotationY(), @ref rotation() const, * @ref rotationY(), @ref rotation() const,
* @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad) * @ref Quaternion::rotation(), @ref Matrix3::rotation(Rad<T>)
*/ */
static Matrix4<T> rotationZ(Rad<T> angle); static Matrix4<T> rotationZ(Rad<T> angle);

2
src/Magnum/MeshTools/BoundingVolume.h

@ -42,7 +42,7 @@ namespace Magnum { namespace MeshTools {
@return Bounding range @return Bounding range
@m_since_latest @m_since_latest
Same as @ref Math::minmax(const Corrade::Containers::StridedArrayView1D<const T>&). Same as @ref Math::minmax(const Containers::StridedArrayView1D<const T>&).
@see @ref Math::Intersection::rayRange(), @see @ref Math::Intersection::rayRange(),
@ref Math::Intersection::rangeFrustum(), @ref Math::Intersection::rangeFrustum(),
@ref Math::Intersection::rangeCone() @ref Math::Intersection::rangeCone()

2
src/Magnum/Platform/AbstractXApplication.h

@ -382,7 +382,7 @@ class AbstractXApplication::GLConfiguration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/AndroidApplication.h

@ -488,7 +488,7 @@ class AndroidApplication::GLConfiguration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/WindowlessCglApplication.h

@ -200,7 +200,7 @@ class WindowlessCglContext::Configuration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/WindowlessEglApplication.h

@ -258,7 +258,7 @@ class WindowlessEglContext::Configuration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/WindowlessGlxApplication.h

@ -253,7 +253,7 @@ class WindowlessGlxContext::Configuration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/WindowlessIosApplication.h

@ -191,7 +191,7 @@ class WindowlessIosContext::Configuration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
src/Magnum/Platform/WindowlessWglApplication.h

@ -240,7 +240,7 @@ class WindowlessWglContext::Configuration: public GL::Context::Configuration {
/** /**
* @brief Context flags * @brief Context flags
* *
* @see @ref setFlags(), @ref Context::Flags * @see @ref setFlags(), @ref GL::Context::Flags
*/ */
typedef Containers::EnumSet<Flag> Flags; typedef Containers::EnumSet<Flag> Flags;

2
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 @brief Landfill texture atlas packer behavior flags
@m_since_latest @m_since_latest
@see @ref Flags, @ref AtlasLandfill::setFlags(), @ref AtlasLandfill::addFlags(), @see @ref AtlasLandfill::setFlags(), @ref AtlasLandfill::addFlags(),
@ref AtlasLandfill::clearFlags() @ref AtlasLandfill::clearFlags()
*/ */
typedef Containers::EnumSet<AtlasLandfillFlag> AtlasLandfillFlags; typedef Containers::EnumSet<AtlasLandfillFlag> AtlasLandfillFlags;

2
src/Magnum/Trade/SceneData.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @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 <Corrade/Containers/Array.h> #include <Corrade/Containers/Array.h>

2
src/Magnum/Vk/ExtensionProperties.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @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 * @m_since_latest
*/ */

Loading…
Cancel
Save