Browse Source

Doc++

pull/231/head
Vladimír Vondruš 8 years ago
parent
commit
28475e1bd8
  1. 3
      doc/changelog.dox
  2. 2
      doc/types.dox
  3. 2
      src/Magnum/MeshTools/RemoveDuplicates.h
  4. 2
      src/Magnum/Platform/AndroidApplication.h
  5. 2
      src/Magnum/Platform/GlfwApplication.h
  6. 2
      src/Magnum/Platform/GlutApplication.h
  7. 2
      src/Magnum/Platform/GlxApplication.h
  8. 2
      src/Magnum/Platform/Platform.h
  9. 2
      src/Magnum/Platform/ScreenedApplication.h
  10. 2
      src/Magnum/Platform/Sdl2Application.h
  11. 2
      src/Magnum/Platform/WindowlessCglApplication.h
  12. 2
      src/Magnum/Platform/WindowlessEglApplication.h
  13. 2
      src/Magnum/Platform/WindowlessGlxApplication.h
  14. 2
      src/Magnum/Platform/WindowlessIosApplication.h
  15. 2
      src/Magnum/Platform/WindowlessWglApplication.h
  16. 2
      src/Magnum/Platform/WindowlessWindowsEglApplication.h
  17. 2
      src/Magnum/Platform/XEglApplication.h
  18. 10
      src/Magnum/SceneGraph/AbstractCamera.h
  19. 2
      src/Magnum/SceneGraph/AbstractTranslation.h
  20. 2
      src/Magnum/SceneGraph/AbstractTranslationRotation2D.h
  21. 8
      src/Magnum/SceneGraph/AbstractTranslationRotation3D.h
  22. 2
      src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h
  23. 2
      src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h
  24. 6
      src/Magnum/SceneGraph/DualComplexTransformation.h
  25. 6
      src/Magnum/SceneGraph/DualQuaternionTransformation.h
  26. 10
      src/Magnum/SceneGraph/MatrixTransformation2D.h
  27. 16
      src/Magnum/SceneGraph/MatrixTransformation3D.h
  28. 8
      src/Magnum/SceneGraph/RigidMatrixTransformation2D.h
  29. 14
      src/Magnum/SceneGraph/RigidMatrixTransformation3D.h
  30. 2
      src/Magnum/SceneGraph/SceneGraph.h
  31. 4
      src/Magnum/SceneGraph/TranslationTransformation.h
  32. 5
      src/Magnum/Trade/AbstractImporter.h
  33. 2
      src/Magnum/Trade/ImageData.h
  34. 2
      src/Magnum/Trade/MeshData2D.h
  35. 2
      src/Magnum/Trade/MeshData3D.h
  36. 2
      src/Magnum/Trade/Trade.h

3
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

2
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.

2
src/Magnum/MeshTools/RemoveDuplicates.h

@ -73,7 +73,7 @@ std::vector<Vector3> 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:

2
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} {}

2
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} {}

2
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} {}

2
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} {}

2
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 {

2
src/Magnum/Platform/ScreenedApplication.h

@ -122,7 +122,7 @@ template<class Application> 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} {}

2
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} {}

2
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} {}

2
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} {}

2
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} {}

2
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} {}

2
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} {}

2
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} {}

2
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} {}

10
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<UnsignedInt dimensions, class T> 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<class T> 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<class T> 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;

2
src/Magnum/SceneGraph/AbstractTranslation.h

@ -90,7 +90,7 @@ class AbstractTranslation: public AbstractTransformation<dimensions, T> {
#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<dimensions, T, TranslationType>& translate(const VectorTypeFor<dimensions, TranslationType>& vector, TransformationType type) {

2
src/Magnum/SceneGraph/AbstractTranslationRotation2D.h

@ -78,7 +78,7 @@ template<class T> 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<T>& rotate(Math::Rad<T> angle, TransformationType type) {

8
src/Magnum/SceneGraph/AbstractTranslationRotation3D.h

@ -82,7 +82,7 @@ template<class T> 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<T>& rotate(Math::Rad<T> angle, const Math::Vector3<T>& normalizedAxis, TransformationType type) {
@ -132,7 +132,7 @@ template<class T> 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<T>& rotateX(Math::Rad<T> angle, TransformationType type) {
@ -182,7 +182,7 @@ template<class T> 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<T>& rotateY(Math::Rad<T> angle, TransformationType type) {
@ -232,7 +232,7 @@ template<class T> 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<T>& rotateZ(Math::Rad<T> angle, TransformationType type) {

2
src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h

@ -78,7 +78,7 @@ template<class T> 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<T>& scale(const Math::Vector2<T>& vector, TransformationType type) {

2
src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h

@ -78,7 +78,7 @@ template<class T> 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<T>& scale(const Math::Vector3<T>& vector, TransformationType type) {

6
src/Magnum/SceneGraph/DualComplexTransformation.h

@ -118,7 +118,7 @@ template<class T> 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<BasicDualComplexTransformation<T>>& transform(const Math::DualComplex<T>& transformation, TransformationType type) {
@ -163,7 +163,7 @@ template<class T> 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<BasicDualComplexTransformation<T>>& translate(const Math::Vector2<T>& vector, TransformationType type) {
@ -207,7 +207,7 @@ template<class T> 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<BasicDualComplexTransformation<T>>& rotate(Math::Rad<T> angle, TransformationType type) {

6
src/Magnum/SceneGraph/DualQuaternionTransformation.h

@ -118,7 +118,7 @@ template<class T> 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<BasicDualQuaternionTransformation<T>>& transform(const Math::DualQuaternion<T>& transformation, TransformationType type) {
@ -162,7 +162,7 @@ template<class T> 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<BasicDualQuaternionTransformation<T>>& translate(const Math::Vector3<T>& vector, TransformationType type) {
@ -209,7 +209,7 @@ template<class T> 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<BasicDualQuaternionTransformation<T>>& rotate(Math::Rad<T> angle, const Math::Vector3<T>& normalizedAxis, TransformationType type) {

10
src/Magnum/SceneGraph/MatrixTransformation2D.h

@ -95,7 +95,7 @@ template<class T> 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<BasicMatrixTransformation2D<T>>& transform(const Math::Matrix3<T>& transformation, TransformationType type) {
@ -145,7 +145,7 @@ template<class T> 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<BasicMatrixTransformation2D<T>>& translate(const Math::Vector2<T>& vector, TransformationType type) {
@ -190,7 +190,7 @@ template<class T> 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<BasicMatrixTransformation2D<T>>& rotate(Math::Rad<T> angle, TransformationType type) {
@ -235,7 +235,7 @@ template<class T> 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<BasicMatrixTransformation2D<T>>& scale(const Math::Vector2<T>& vector, TransformationType type) {
@ -282,7 +282,7 @@ template<class T> 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<BasicMatrixTransformation2D<T>>& reflect(const Math::Vector2<T>& normal, TransformationType type) {

16
src/Magnum/SceneGraph/MatrixTransformation3D.h

@ -100,7 +100,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& transform(const Math::Matrix4<T>& transformation, TransformationType type) {
@ -145,7 +145,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& translate(const Math::Vector3<T>& vector, TransformationType type) {
@ -193,7 +193,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& rotate(Math::Rad<T> angle, const Math::Vector3<T>& normalizedAxis, TransformationType type) {
@ -238,7 +238,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& rotateX(Math::Rad<T> angle, TransformationType type) {
@ -283,7 +283,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& rotateY(Math::Rad<T> angle, TransformationType type) {
@ -328,7 +328,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& rotateZ(Math::Rad<T> angle, TransformationType type) {
@ -373,7 +373,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& scale(const Math::Vector3<T>& vector, TransformationType type) {
@ -419,7 +419,7 @@ template<class T> 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<BasicMatrixTransformation3D<T>>& reflect(const Math::Vector3<T>& normal, TransformationType type) {

8
src/Magnum/SceneGraph/RigidMatrixTransformation2D.h

@ -123,7 +123,7 @@ template<class T> 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<BasicRigidMatrixTransformation2D<T>>& transform(const Math::Matrix3<T>& transformation, TransformationType type) {
@ -168,7 +168,7 @@ template<class T> 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<BasicRigidMatrixTransformation2D<T>>& translate(const Math::Vector2<T>& vector, TransformationType type) {
@ -214,7 +214,7 @@ template<class T> 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<BasicRigidMatrixTransformation2D<T>>& rotate(Math::Rad<T> angle, TransformationType type) {
@ -260,7 +260,7 @@ template<class T> 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<BasicRigidMatrixTransformation2D<T>>& reflect(const Math::Vector2<T>& normal, TransformationType type) {

14
src/Magnum/SceneGraph/RigidMatrixTransformation3D.h

@ -122,7 +122,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& transform(const Math::Matrix4<T>& transformation, TransformationType type) {
@ -167,7 +167,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& translate(const Math::Vector3<T>& vector, TransformationType type) {
@ -216,7 +216,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& rotate(Math::Rad<T> angle, const Math::Vector3<T>& normalizedAxis, TransformationType type) {
@ -261,7 +261,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& rotateX(Math::Rad<T> angle, TransformationType type) {
@ -306,7 +306,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& rotateY(Math::Rad<T> angle, TransformationType type) {
@ -351,7 +351,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& rotateZ(Math::Rad<T> angle, TransformationType type) {
@ -397,7 +397,7 @@ template<class T> 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<BasicRigidMatrixTransformation3D<T>>& reflect(const Math::Vector3<T>& normal, TransformationType type) {

2
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"

4
src/Magnum/SceneGraph/TranslationTransformation.h

@ -103,7 +103,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
#pragma warning(disable: 4996)
#endif
/**
* @copybrief transform()
* @brief @copybrief transform()
* @deprecated Use @ref transform() instead.
*/
CORRADE_DEPRECATED("use transform() instead") Object<TranslationTransformation<dimensions, T, TranslationType>>& transform(const VectorTypeFor<dimensions, TranslationType>& transformation, TransformationType) {
@ -139,7 +139,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
#pragma warning(disable: 4996)
#endif
/**
* @copybrief translate()
* @brief @copybrief translate()
* @deprecated Use @ref translate() instead.
*/
CORRADE_DEPRECATED("use translate() instead") Object<TranslationTransformation<dimensions, T, TranslationType>>& translate(const VectorTypeFor<dimensions, TranslationType>& vector, TransformationType) {

5
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);

2
src/Magnum/Trade/ImageData.h

@ -76,7 +76,7 @@ template<UnsignedInt dimensions> class ImageData {
explicit ImageData(PixelFormat format, PixelType type, const VectorTypeFor<dimensions, Int>& size, Containers::Array<char>&& data, const void* importerState = nullptr) noexcept: ImageData{{}, format, type, size, std::move(data), importerState} {}
#ifdef MAGNUM_BUILD_DEPRECATED
/** @copybrief ImageData(PixelFormat, PixelType, const VectorTypeFor<dimensions, Int>&, Containers::Array<char>&&, const void*)
/** @brief @copybrief ImageData(PixelFormat, PixelType, const VectorTypeFor<dimensions, Int>&, Containers::Array<char>&&, const void*)
* @deprecated Use @ref ImageData(PixelFormat, PixelType, const VectorTypeFor<dimensions, Int>&, Containers::Array<char>&&, const void*) instead.
*/
explicit CORRADE_DEPRECATED("use ImageData(PixelFormat, PixelType, const VectorTypeFor&, Containers::Array&&) instead") ImageData(PixelFormat format, PixelType type, const VectorTypeFor<dimensions, Int>& size, void* data) noexcept: ImageData{format, type, size, Containers::Array<char>{reinterpret_cast<char*>(data), Magnum::Implementation::imageDataSizeFor(format, type, size)}} {}

2
src/Magnum/Trade/MeshData2D.h

@ -60,7 +60,7 @@ class MAGNUM_EXPORT MeshData2D {
explicit MeshData2D(MeshPrimitive primitive, std::vector<UnsignedInt> indices, std::vector<std::vector<Vector2>> positions, std::vector<std::vector<Vector2>> textureCoords2D, std::vector<std::vector<Color4>> colors, const void* importerState = nullptr);
#ifdef MAGNUM_BUILD_DEPRECATED
/** @copybrief MeshData2D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*)
/** @brief @copybrief MeshData2D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*)
* @deprecated Use @ref MeshData2D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*) instead.
*/
CORRADE_DEPRECATED("Use MeshData2D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*) instead") explicit MeshData2D(MeshPrimitive primitive, std::vector<UnsignedInt> indices, std::vector<std::vector<Vector2>> positions, std::vector<std::vector<Vector2>> textureCoords2D, const void* importerState = nullptr);

2
src/Magnum/Trade/MeshData3D.h

@ -61,7 +61,7 @@ class MAGNUM_EXPORT MeshData3D {
explicit MeshData3D(MeshPrimitive primitive, std::vector<UnsignedInt> indices, std::vector<std::vector<Vector3>> positions, std::vector<std::vector<Vector3>> normals, std::vector<std::vector<Vector2>> textureCoords2D, std::vector<std::vector<Color4>> colors, const void* importerState = nullptr);
#ifdef MAGNUM_BUILD_DEPRECATED
/** @copybrief MeshData3D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*)
/** @brief @copybrief MeshData3D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*)
* @deprecated Use @ref MeshData3D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*) instead.
*/
CORRADE_DEPRECATED("Use MeshData3D(MeshPrimitive, std::vector<UnsignedInt>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector3>>, std::vector<std::vector<Vector2>>, std::vector<std::vector<Color4>>, const void*) instead") explicit MeshData3D(MeshPrimitive primitive, std::vector<UnsignedInt> indices, std::vector<std::vector<Vector3>> positions, std::vector<std::vector<Vector3>> normals, std::vector<std::vector<Vector2>> textureCoords2D, const void* importerState = nullptr);

2
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"

Loading…
Cancel
Save