diff --git a/doc/changelog.dox b/doc/changelog.dox index 8f6981b43..3b3d6b7cc 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -542,7 +542,8 @@ See also: - @ref Shaders::Generic::Color vertex attribute implicit constructor is deprecated, use a constructor with explicit component count instead - The bundled `std::optional` implementation was causing serious conflicts - with C++17 and it's now deprecated in favor of @ref Containers::Optional. + with C++17 and it's now deprecated in favor of + @ref Corrade::Containers::Optional. (Deprecated) aliases and conversion operators are provided for backwards compatibility. - `Audio::Context::hrtfSpecifier()` is deprecated, use diff --git a/doc/types.dox b/doc/types.dox index 6cef8acc5..8e5cc591a 100644 --- a/doc/types.dox +++ b/doc/types.dox @@ -130,7 +130,7 @@ the @ref Deg and @ref Rad classes (or @ref Degd and @ref Radd with @ref Double as underlying type). Their only purpose is to avoid common degree-vs-radian bugs (i.e. entering degree value where radians should be) and make the conversion between these two representations easier. They are just a tiny -@cpp inline constexpr @ce wrapper around the native type and they support all +@cpp constexpr @ce wrapper around the native type and they support all meaningful numeric operations, so using them won't have any performance or usability impact in practice. diff --git a/src/Magnum/MeshTools/RemoveDuplicates.h b/src/Magnum/MeshTools/RemoveDuplicates.h index 91d56d09a..1a364ecba 100644 --- a/src/Magnum/MeshTools/RemoveDuplicates.h +++ b/src/Magnum/MeshTools/RemoveDuplicates.h @@ -73,7 +73,7 @@ std::vector positions; indices = MeshTools::duplicate(indices, MeshTools::removeDuplicates(positions)); @endcode -Removing duplicates in multiple indcidental arrays is also possible -- first +Removing duplicates in multiple indcidental arrays is also possible --- first remove duplicates in each array separately and then use @ref combineIndexedArrays() to combine the resulting index arrays to single index array and reorder the data accordingly: diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index ff9b07789..43d861078 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -235,7 +235,7 @@ class AndroidApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief AndroidApplication(const Arguments&, NoCreateT) + * @brief @copybrief AndroidApplication(const Arguments&, NoCreateT) * @deprecated Use @ref AndroidApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use AndroidApplication(const Arguments&, NoCreateT) instead") explicit AndroidApplication(const Arguments& arguments, std::nullptr_t): AndroidApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index ebee94082..cda2f27e0 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -143,7 +143,7 @@ class GlfwApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief GlfwApplication(const Arguments&, NoCreateT) + * @brief @copybrief GlfwApplication(const Arguments&, NoCreateT) * @deprecated Use @ref GlfwApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use GlfwApplication(const Arguments&, NoCreateT) instead") explicit GlfwApplication(const Arguments& arguments, std::nullptr_t): GlfwApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/GlutApplication.h b/src/Magnum/Platform/GlutApplication.h index eeb4d46fc..60e8b77ad 100644 --- a/src/Magnum/Platform/GlutApplication.h +++ b/src/Magnum/Platform/GlutApplication.h @@ -137,7 +137,7 @@ class GlutApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief GlutApplication(const Arguments&, NoCreateT) + * @brief @copybrief GlutApplication(const Arguments&, NoCreateT) * @deprecated Use @ref GlutApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use GlutApplication(const Arguments&, NoCreateT) instead") explicit GlutApplication(const Arguments& arguments, std::nullptr_t): GlutApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/GlxApplication.h b/src/Magnum/Platform/GlxApplication.h index 75effcc15..b5bf3c7ce 100644 --- a/src/Magnum/Platform/GlxApplication.h +++ b/src/Magnum/Platform/GlxApplication.h @@ -104,7 +104,7 @@ class GlxApplication: public AbstractXApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief GlxApplication(const Arguments&, NoCreateT) + * @brief @copybrief GlxApplication(const Arguments&, NoCreateT) * @deprecated Use @ref GlxApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use GlxApplication(const Arguments&, NoCreateT) instead") explicit GlxApplication(const Arguments& arguments, std::nullptr_t): GlxApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/Platform.h b/src/Magnum/Platform/Platform.h index 276e08fa1..e22a02dbc 100644 --- a/src/Magnum/Platform/Platform.h +++ b/src/Magnum/Platform/Platform.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Forward declarations for @ref Magnum::Platform namespace + * @brief Forward declarations for the @ref Magnum::Platform namespace */ namespace Magnum { namespace Platform { diff --git a/src/Magnum/Platform/ScreenedApplication.h b/src/Magnum/Platform/ScreenedApplication.h index 85ca422c5..72a1ab015 100644 --- a/src/Magnum/Platform/ScreenedApplication.h +++ b/src/Magnum/Platform/ScreenedApplication.h @@ -122,7 +122,7 @@ template class BasicScreenedApplication: public Application, #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief BasicScreenedApplication(const typename Application::Arguments&, NoCreateT) + * @brief @copybrief BasicScreenedApplication(const typename Application::Arguments&, NoCreateT) * @deprecated Use @ref BasicScreenedApplication(const typename Application::Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use BasicScreenedApplication(const Arguments&, NoCreateT) instead") explicit BasicScreenedApplication(const typename Application::Arguments& arguments, std::nullptr_t): BasicScreenedApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index ae400d1e7..a84f8a415 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -400,7 +400,7 @@ class Sdl2Application { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Sdl2Application(const Arguments&, NoCreateT) + * @brief @copybrief Sdl2Application(const Arguments&, NoCreateT) * @deprecated Use @ref Sdl2Application(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use Sdl2Application(const Arguments&, NoCreateT) instead") explicit Sdl2Application(const Arguments& arguments, std::nullptr_t): Sdl2Application{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index 3c1977684..d76c864c4 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -243,7 +243,7 @@ class WindowlessCglApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessCglApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessCglApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessCglApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessCglApplication(const Arguments&, NoCreateT) instead") explicit WindowlessCglApplication(const Arguments& arguments, std::nullptr_t): WindowlessCglApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessEglApplication.h b/src/Magnum/Platform/WindowlessEglApplication.h index 9b362520f..fd8e906ae 100644 --- a/src/Magnum/Platform/WindowlessEglApplication.h +++ b/src/Magnum/Platform/WindowlessEglApplication.h @@ -370,7 +370,7 @@ class WindowlessEglApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessEglApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessEglApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessEglApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessEglApplication(const Arguments&, NoCreateT) instead") explicit WindowlessEglApplication(const Arguments& arguments, std::nullptr_t): WindowlessEglApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 244acc5af..d0d2c5e18 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -292,7 +292,7 @@ class WindowlessGlxApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessGlxApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessGlxApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessGlxApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessGlxApplication(const Arguments&, NoCreateT) instead") explicit WindowlessGlxApplication(const Arguments& arguments, std::nullptr_t): WindowlessGlxApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessIosApplication.h b/src/Magnum/Platform/WindowlessIosApplication.h index d99b53eda..1f1e5f0b8 100644 --- a/src/Magnum/Platform/WindowlessIosApplication.h +++ b/src/Magnum/Platform/WindowlessIosApplication.h @@ -241,7 +241,7 @@ class WindowlessIosApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessIosApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessIosApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessIosApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessIosApplication(const Arguments&, NoCreateT) instead") explicit WindowlessIosApplication(const Arguments& arguments, std::nullptr_t): WindowlessIosApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index f33d7ee02..960e45145 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -291,7 +291,7 @@ class WindowlessWglApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessWglApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessWglApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessWglApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessWglApplication(const Arguments&, NoCreateT) instead") explicit WindowlessWglApplication(const Arguments& arguments, std::nullptr_t): WindowlessWglApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/WindowlessWindowsEglApplication.h b/src/Magnum/Platform/WindowlessWindowsEglApplication.h index 47d8a210c..764fff93b 100644 --- a/src/Magnum/Platform/WindowlessWindowsEglApplication.h +++ b/src/Magnum/Platform/WindowlessWindowsEglApplication.h @@ -280,7 +280,7 @@ class WindowlessWindowsEglApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief WindowlessWindowsEglApplication(const Arguments&, NoCreateT) + * @brief @copybrief WindowlessWindowsEglApplication(const Arguments&, NoCreateT) * @deprecated Use @ref WindowlessWindowsEglApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use WindowlessWindowsEglApplication(const Arguments&, NoCreateT) instead") explicit WindowlessWindowsEglApplication(const Arguments& arguments, std::nullptr_t): WindowlessWindowsEglApplication{arguments, NoCreate} {} diff --git a/src/Magnum/Platform/XEglApplication.h b/src/Magnum/Platform/XEglApplication.h index 951509b1e..52ffd7c77 100644 --- a/src/Magnum/Platform/XEglApplication.h +++ b/src/Magnum/Platform/XEglApplication.h @@ -105,7 +105,7 @@ class XEglApplication: public AbstractXApplication { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief XEglApplication(const Arguments&, NoCreateT) + * @brief @copybrief XEglApplication(const Arguments&, NoCreateT) * @deprecated Use @ref XEglApplication(const Arguments&, NoCreateT) instead. */ CORRADE_DEPRECATED("use XEglApplication(const Arguments&, NoCreateT) instead") explicit XEglApplication(const Arguments& arguments, std::nullptr_t): XEglApplication{arguments, NoCreate} {} diff --git a/src/Magnum/SceneGraph/AbstractCamera.h b/src/Magnum/SceneGraph/AbstractCamera.h index 64a3b7fab..db8a565c1 100644 --- a/src/Magnum/SceneGraph/AbstractCamera.h +++ b/src/Magnum/SceneGraph/AbstractCamera.h @@ -38,7 +38,7 @@ CORRADE_DEPRECATED_FILE("use Magnum/SceneGraph/Camera.h instead") namespace Magnum { namespace SceneGraph { /** - * @copybrief Camera + * @brief @copybrief Camera * @deprecated Use @ref Camera instead. */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ @@ -46,7 +46,7 @@ template using AbstractCamera CORRADE_DEPRECATE #endif /** - * @copybrief BasicCamera2D + * @brief @copybrief BasicCamera2D * @deprecated Use @ref BasicCamera2D instead. */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ @@ -54,13 +54,13 @@ template using AbstractBasicCamera2D CORRADE_DEPRECATED_ALIAS("use Basi #endif /** - * @copybrief Camera2D + * @brief @copybrief Camera2D * @deprecated Use @ref Camera2D instead. */ CORRADE_DEPRECATED("use Camera2D instead") typedef Camera2D AbstractCamera2D; /** - * @copybrief BasicCamera3D + * @brief @copybrief BasicCamera3D * @deprecated Use @ref BasicCamera3D instead. */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ @@ -68,7 +68,7 @@ template using AbstractBasicCamera3D CORRADE_DEPRECATED_ALIAS("use Basi #endif /** - * @copybrief Camera3D + * @brief @copybrief Camera3D * @deprecated Use @ref Camera3D instead. */ CORRADE_DEPRECATED("use Camera3D instead") typedef Camera3D AbstractCamera3D; diff --git a/src/Magnum/SceneGraph/AbstractTranslation.h b/src/Magnum/SceneGraph/AbstractTranslation.h index 25149501f..a2586aa2d 100644 --- a/src/Magnum/SceneGraph/AbstractTranslation.h +++ b/src/Magnum/SceneGraph/AbstractTranslation.h @@ -90,7 +90,7 @@ class AbstractTranslation: public AbstractTransformation { #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") AbstractTranslation& translate(const VectorTypeFor& vector, TransformationType type) { diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h index 426a9612b..0b0b41985 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h @@ -78,7 +78,7 @@ template class AbstractBasicTranslationRotation2D: public AbstractBasic #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") AbstractBasicTranslationRotation2D& rotate(Math::Rad angle, TransformationType type) { diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h index 0c02da4dd..20c15fc44 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h @@ -82,7 +82,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") AbstractBasicTranslationRotation3D& rotate(Math::Rad angle, const Math::Vector3& normalizedAxis, TransformationType type) { @@ -132,7 +132,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #pragma warning(disable: 4996) #endif /** - * @copybrief rotateX() + * @brief @copybrief rotateX() * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") AbstractBasicTranslationRotation3D& rotateX(Math::Rad angle, TransformationType type) { @@ -182,7 +182,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #pragma warning(disable: 4996) #endif /** - * @copybrief rotateY() + * @brief @copybrief rotateY() * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") AbstractBasicTranslationRotation3D& rotateY(Math::Rad angle, TransformationType type) { @@ -232,7 +232,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #pragma warning(disable: 4996) #endif /** - * @copybrief rotateZ() + * @brief @copybrief rotateZ() * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") AbstractBasicTranslationRotation3D& rotateZ(Math::Rad angle, TransformationType type) { diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h index a037f956c..6cf08e809 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h @@ -78,7 +78,7 @@ template class AbstractBasicTranslationRotationScaling2D: public Abstra #pragma warning(disable: 4996) #endif /** - * @copybrief scale() + * @brief @copybrief scale() * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") AbstractBasicTranslationRotationScaling2D& scale(const Math::Vector2& vector, TransformationType type) { diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h index e1f275d9c..5e7bbb64f 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h @@ -78,7 +78,7 @@ template class AbstractBasicTranslationRotationScaling3D: public Abstra #pragma warning(disable: 4996) #endif /** - * @copybrief scale() + * @brief @copybrief scale() * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") AbstractBasicTranslationRotationScaling3D& scale(const Math::Vector3& vector, TransformationType type) { diff --git a/src/Magnum/SceneGraph/DualComplexTransformation.h b/src/Magnum/SceneGraph/DualComplexTransformation.h index 3d82312e4..f5d1786c4 100644 --- a/src/Magnum/SceneGraph/DualComplexTransformation.h +++ b/src/Magnum/SceneGraph/DualComplexTransformation.h @@ -118,7 +118,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::DualComplex& transformation, TransformationType type) { @@ -163,7 +163,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { @@ -207,7 +207,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { diff --git a/src/Magnum/SceneGraph/DualQuaternionTransformation.h b/src/Magnum/SceneGraph/DualQuaternionTransformation.h index ebfc65319..8455102b0 100644 --- a/src/Magnum/SceneGraph/DualQuaternionTransformation.h +++ b/src/Magnum/SceneGraph/DualQuaternionTransformation.h @@ -118,7 +118,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::DualQuaternion& transformation, TransformationType type) { @@ -162,7 +162,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { @@ -209,7 +209,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("usr rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, const Math::Vector3& normalizedAxis, TransformationType type) { diff --git a/src/Magnum/SceneGraph/MatrixTransformation2D.h b/src/Magnum/SceneGraph/MatrixTransformation2D.h index 2d255db52..de1e4c445 100644 --- a/src/Magnum/SceneGraph/MatrixTransformation2D.h +++ b/src/Magnum/SceneGraph/MatrixTransformation2D.h @@ -95,7 +95,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix3& transformation, TransformationType type) { @@ -145,7 +145,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { @@ -190,7 +190,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { @@ -235,7 +235,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief scale() + * @brief @copybrief scale() * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") Object>& scale(const Math::Vector2& vector, TransformationType type) { @@ -282,7 +282,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief reflect() + * @brief @copybrief reflect() * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector2& normal, TransformationType type) { diff --git a/src/Magnum/SceneGraph/MatrixTransformation3D.h b/src/Magnum/SceneGraph/MatrixTransformation3D.h index 689bd6cdb..041eeb0a9 100644 --- a/src/Magnum/SceneGraph/MatrixTransformation3D.h +++ b/src/Magnum/SceneGraph/MatrixTransformation3D.h @@ -100,7 +100,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix4& transformation, TransformationType type) { @@ -145,7 +145,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { @@ -193,7 +193,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, const Math::Vector3& normalizedAxis, TransformationType type) { @@ -238,7 +238,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief rotateX() + * @brief @copybrief rotateX() * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") Object>& rotateX(Math::Rad angle, TransformationType type) { @@ -283,7 +283,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief rotateY() + * @brief @copybrief rotateY() * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") Object>& rotateY(Math::Rad angle, TransformationType type) { @@ -328,7 +328,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief rotateZ() + * @brief @copybrief rotateZ() * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") Object>& rotateZ(Math::Rad angle, TransformationType type) { @@ -373,7 +373,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief scale() + * @brief @copybrief scale() * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") Object>& scale(const Math::Vector3& vector, TransformationType type) { @@ -419,7 +419,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #pragma warning(disable: 4996) #endif /** - * @copybrief reflect() + * @brief @copybrief reflect() * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector3& normal, TransformationType type) { diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h index 3dd99abe8..d5b551d01 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h @@ -123,7 +123,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix3& transformation, TransformationType type) { @@ -168,7 +168,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { @@ -214,7 +214,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { @@ -260,7 +260,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief reflect() + * @brief @copybrief reflect() * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectInternal() instead") Object>& reflect(const Math::Vector2& normal, TransformationType type) { diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h index 32f24dbbe..4f6b22565 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h @@ -122,7 +122,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief transform() + * @brief @copybrief transform() * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix4& transformation, TransformationType type) { @@ -167,7 +167,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief translate() + * @brief @copybrief translate() * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { @@ -216,7 +216,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief rotate() + * @brief @copybrief rotate() * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, const Math::Vector3& normalizedAxis, TransformationType type) { @@ -261,7 +261,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief rotateX() + * @brief @copybrief rotateX() * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") Object>& rotateX(Math::Rad angle, TransformationType type) { @@ -306,7 +306,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief rotateY() + * @brief @copybrief rotateY() * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") Object>& rotateY(Math::Rad angle, TransformationType type) { @@ -351,7 +351,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief rotateZ() + * @brief @copybrief rotateZ() * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") Object>& rotateZ(Math::Rad angle, TransformationType type) { @@ -397,7 +397,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #pragma warning(disable: 4996) #endif /** - * @copybrief reflect() + * @brief @copybrief reflect() * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector3& normal, TransformationType type) { diff --git a/src/Magnum/SceneGraph/SceneGraph.h b/src/Magnum/SceneGraph/SceneGraph.h index 72bbbb014..2040b67f7 100644 --- a/src/Magnum/SceneGraph/SceneGraph.h +++ b/src/Magnum/SceneGraph/SceneGraph.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Forward declarations for @ref Magnum::SceneGraph namespace + * @brief Forward declarations for the @ref Magnum::SceneGraph namespace */ #include "Magnum/Types.h" diff --git a/src/Magnum/SceneGraph/TranslationTransformation.h b/src/Magnum/SceneGraph/TranslationTransformation.h index 41136db07..19ff31c92 100644 --- a/src/Magnum/SceneGraph/TranslationTransformation.h +++ b/src/Magnum/SceneGraph/TranslationTransformation.h @@ -103,7 +103,7 @@ class TranslationTransformation: public AbstractTranslation>& transform(const VectorTypeFor& transformation, TransformationType) { @@ -139,7 +139,7 @@ class TranslationTransformation: public AbstractTranslation>& translate(const VectorTypeFor& vector, TransformationType) { diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index dee09422f..e57c38c16 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -522,8 +522,9 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug * @brief Implementation for @ref openFile() * * If @ref Feature::OpenData is supported, default implementation opens - * the file and calls @ref doOpenData() with its contents. It is - * allowed to call this function from your @ref doOpenFile() + * the file and calls @ref Magnum::Trade::AbstractImporter::doOpenData() "doOpenData()" + * with its contents. It is allowed to call this function from your + * @ref Magnum::Trade::AbstractImporter::doOpenFile() "doOpenFile()" * implementation. */ virtual void doOpenFile(const std::string& filename); diff --git a/src/Magnum/Trade/ImageData.h b/src/Magnum/Trade/ImageData.h index 98cff2631..7a70ad2e3 100644 --- a/src/Magnum/Trade/ImageData.h +++ b/src/Magnum/Trade/ImageData.h @@ -76,7 +76,7 @@ template class ImageData { explicit ImageData(PixelFormat format, PixelType type, const VectorTypeFor& size, Containers::Array&& data, const void* importerState = nullptr) noexcept: ImageData{{}, format, type, size, std::move(data), importerState} {} #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief ImageData(PixelFormat, PixelType, const VectorTypeFor&, Containers::Array&&, const void*) + /** @brief @copybrief ImageData(PixelFormat, PixelType, const VectorTypeFor&, Containers::Array&&, const void*) * @deprecated Use @ref ImageData(PixelFormat, PixelType, const VectorTypeFor&, Containers::Array&&, const void*) instead. */ explicit CORRADE_DEPRECATED("use ImageData(PixelFormat, PixelType, const VectorTypeFor&, Containers::Array&&) instead") ImageData(PixelFormat format, PixelType type, const VectorTypeFor& size, void* data) noexcept: ImageData{format, type, size, Containers::Array{reinterpret_cast(data), Magnum::Implementation::imageDataSizeFor(format, type, size)}} {} diff --git a/src/Magnum/Trade/MeshData2D.h b/src/Magnum/Trade/MeshData2D.h index 4302d34a7..946914395 100644 --- a/src/Magnum/Trade/MeshData2D.h +++ b/src/Magnum/Trade/MeshData2D.h @@ -60,7 +60,7 @@ class MAGNUM_EXPORT MeshData2D { explicit MeshData2D(MeshPrimitive primitive, std::vector indices, std::vector> positions, std::vector> textureCoords2D, std::vector> colors, const void* importerState = nullptr); #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief MeshData2D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, const void*) + /** @brief @copybrief MeshData2D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, const void*) * @deprecated Use @ref MeshData2D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, const void*) instead. */ CORRADE_DEPRECATED("Use MeshData2D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, const void*) instead") explicit MeshData2D(MeshPrimitive primitive, std::vector indices, std::vector> positions, std::vector> textureCoords2D, const void* importerState = nullptr); diff --git a/src/Magnum/Trade/MeshData3D.h b/src/Magnum/Trade/MeshData3D.h index dcbd0f62f..8fe42a4f1 100644 --- a/src/Magnum/Trade/MeshData3D.h +++ b/src/Magnum/Trade/MeshData3D.h @@ -61,7 +61,7 @@ class MAGNUM_EXPORT MeshData3D { explicit MeshData3D(MeshPrimitive primitive, std::vector indices, std::vector> positions, std::vector> normals, std::vector> textureCoords2D, std::vector> colors, const void* importerState = nullptr); #ifdef MAGNUM_BUILD_DEPRECATED - /** @copybrief MeshData3D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, std::vector>, const void*) + /** @brief @copybrief MeshData3D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, std::vector>, const void*) * @deprecated Use @ref MeshData3D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, std::vector>, const void*) instead. */ CORRADE_DEPRECATED("Use MeshData3D(MeshPrimitive, std::vector, std::vector>, std::vector>, std::vector>, std::vector>, const void*) instead") explicit MeshData3D(MeshPrimitive primitive, std::vector indices, std::vector> positions, std::vector> normals, std::vector> textureCoords2D, const void* importerState = nullptr); diff --git a/src/Magnum/Trade/Trade.h b/src/Magnum/Trade/Trade.h index 924d1146f..3b9d65573 100644 --- a/src/Magnum/Trade/Trade.h +++ b/src/Magnum/Trade/Trade.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Forward declarations for Magnum::Trade namespace + * @brief Forward declarations for the @ref Magnum::Trade namespace */ #include "Magnum/Types.h"