From 79ff9e1ca4c23a94a264ae931da1d9fea6f65cf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 8 Dec 2013 02:24:53 +0100 Subject: [PATCH] Marking deprecated functions and types with CORRADE_DEPRECATED(). Sadly enum values can't be marked as such. --- src/AbstractShaderProgram.h | 2 +- src/AbstractTexture.h | 2 +- src/Buffer.h | 6 +++--- src/ImageFormat.h | 4 ++-- src/Magnum.h | 16 ++++++++++------ src/Math/Geometry/Rectangle.h | 6 ++++-- src/Sampler.h | 2 +- src/SceneGraph/Animable.h | 4 ++-- src/Swizzle.h | 2 +- src/Text/TextRenderer.h | 10 +++++----- 10 files changed, 30 insertions(+), 24 deletions(-) diff --git a/src/AbstractShaderProgram.h b/src/AbstractShaderProgram.h index ee5418187..4ce0e6e46 100644 --- a/src/AbstractShaderProgram.h +++ b/src/AbstractShaderProgram.h @@ -340,7 +340,7 @@ class MAGNUM_EXPORT AbstractShaderProgram { * @deprecated Use @ref Magnum::AbstractShaderProgram::maxVertexAttributes() "maxVertexAttributes()" * instead. */ - static Int maxSupportedVertexAttributeCount() { return maxVertexAttributes(); } + static CORRADE_DEPRECATED("use maxVertexAttributes() instead") Int maxSupportedVertexAttributeCount() { return maxVertexAttributes(); } #endif #ifndef MAGNUM_TARGET_GLES diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index 406f4f674..d05ef82b5 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -115,7 +115,7 @@ class MAGNUM_EXPORT AbstractTexture { * @deprecated Use @ref Magnum::AbstractTexture::maxLayers() "maxLayers()" * instead. */ - static Int maxSupportedLayerCount() { return maxLayers(); } + static CORRADE_DEPRECATED("use maxLayers() instead") Int maxSupportedLayerCount() { return maxLayers(); } #endif #ifndef MAGNUM_TARGET_GLES diff --git a/src/Buffer.h b/src/Buffer.h index d65215739..a3fc8ca17 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -306,7 +306,7 @@ class MAGNUM_EXPORT Buffer { * @copybrief BufferUsage * @deprecated Use @ref Magnum::BufferUsage "BufferUsage" instead. */ - typedef BufferUsage Usage; + typedef CORRADE_DEPRECATED("use BufferUsage instead") BufferUsage Usage; #endif /** @@ -653,7 +653,7 @@ class MAGNUM_EXPORT Buffer { * @deprecated Use @ref Magnum::Buffer::setData(Containers::ArrayReference, BufferUsage) "setData(Containers::ArrayReference, BufferUsage)" * instead. */ - Buffer& setData(GLsizeiptr size, const GLvoid* data, BufferUsage usage) { + CORRADE_DEPRECATED("use setData(Containers::ArrayReference, BufferUsage) instead") Buffer& setData(GLsizeiptr size, const GLvoid* data, BufferUsage usage) { return setData({data, std::size_t(size)}, usage); } #endif @@ -693,7 +693,7 @@ class MAGNUM_EXPORT Buffer { * @deprecated Use @ref Magnum::Buffer::setSubData(GLintptr, Containers::ArrayReference) "setSubData(GLintptr, Containers::ArrayReference)" * instead. */ - Buffer& setSubData(GLintptr offset, GLsizeiptr size, const GLvoid* data) { + CORRADE_DEPRECATED("use setSubData(GLintptr, Containers::ArrayReference) instead") Buffer& setSubData(GLintptr offset, GLsizeiptr size, const GLvoid* data) { return setSubData(offset, {data, std::size_t(size)}); } #endif diff --git a/src/ImageFormat.h b/src/ImageFormat.h index 5ec6e8a31..68b65db46 100644 --- a/src/ImageFormat.h +++ b/src/ImageFormat.h @@ -38,13 +38,13 @@ namespace Magnum { @copybrief ColorFormat @deprecated Use @ref Magnum::ColorFormat "ColorFormat" instead. */ -typedef ColorFormat ImageFormat; +typedef CORRADE_DEPRECATED("use ColorFormat instead") ColorFormat ImageFormat; /** @copybrief ColorType @deprecated Use @ref Magnum::ColorType "ColorType" instead. */ -typedef ColorType ImageType; +typedef CORRADE_DEPRECATED("use ColorType instead") ColorType ImageType; } #else diff --git a/src/Magnum.h b/src/Magnum.h index 3f6f49147..7485b1fcb 100644 --- a/src/Magnum.h +++ b/src/Magnum.h @@ -34,6 +34,10 @@ #include "Types.h" #include "magnumConfigure.h" +#ifdef MAGNUM_BUILD_DEPRECATED +#include +#endif + #ifndef DOXYGEN_GENERATING_OUTPUT typedef unsigned int GLenum; /* Needed for *Format and *Type enums */ #endif @@ -330,15 +334,15 @@ typedef Math::Range3D Range3Di; #ifdef MAGNUM_BUILD_DEPRECATED /** @copybrief Range2D -@deprecated Use @ref Magnum::Range2D instead. +@deprecated Use @ref Magnum::Range2D "Range2D" instead. */ -typedef Math::Geometry::Rectangle Rectangle; +typedef CORRADE_DEPRECATED("use Range2D instead") Math::Geometry::Rectangle Rectangle; /** @copybrief Range2Di -@deprecated Use @ref Magnum::Range2Di instead. +@deprecated Use @ref Magnum::Range2Di "Range2Di" instead. */ -typedef Math::Geometry::Rectangle Rectanglei; +typedef CORRADE_DEPRECATED("use Range2Di instead") Math::Geometry::Rectangle Rectanglei; #endif /*@}*/ @@ -388,7 +392,7 @@ typedef Math::Matrix<2, Double> Matrix2x2d; @copybrief Matrix2x2d @deprecated Use @ref Magnum::Matrix2x2d "Matrix2x2d" instead. */ -typedef Math::Matrix<2, Double> Matrix2d; +typedef CORRADE_DEPRECATED("use Matrix2x2d instead") Math::Matrix<2, Double> Matrix2d; #endif /** @@ -496,7 +500,7 @@ typedef Math::Range3D Range3Dd; @copybrief Range2Dd @deprecated Use @ref Magnum::Range2Dd instead. */ -typedef Math::Geometry::Rectangle Rectangled; +typedef CORRADE_DEPRECATED("use Range2Dd instead") Math::Geometry::Rectangle Rectangled; #endif /*@}*/ diff --git a/src/Math/Geometry/Rectangle.h b/src/Math/Geometry/Rectangle.h index bd2153a41..c3833fbf4 100644 --- a/src/Math/Geometry/Rectangle.h +++ b/src/Math/Geometry/Rectangle.h @@ -32,13 +32,15 @@ #include "Math/Range.h" #ifdef MAGNUM_BUILD_DEPRECATED +#include + namespace Magnum { namespace Math { namespace Geometry { /** @copybrief Math::Range2D -@deprecated Use @ref Magnum::Math::Range2D instead. +@deprecated Use @ref Magnum::Math::Range2D "Math::Range2D" instead. */ -template class Rectangle: public Range2D { +template class CORRADE_DEPRECATED("use Math::Range2D instead") Rectangle: public Range2D { public: /** @copydoc Range2D() */ constexpr Rectangle() = default; diff --git a/src/Sampler.h b/src/Sampler.h index 43d507720..85360d4af 100644 --- a/src/Sampler.h +++ b/src/Sampler.h @@ -149,7 +149,7 @@ class MAGNUM_EXPORT Sampler { * @deprecated Use @ref Magnum::Sampler::maxAnisotropy() "maxAnisotropy()" * instead. */ - static Float maxSupportedAnisotropy() { return maxAnisotropy(); } + static CORRADE_DEPRECATED("use maxAnisotropy() instead") Float maxSupportedAnisotropy() { return maxAnisotropy(); } #endif }; diff --git a/src/SceneGraph/Animable.h b/src/SceneGraph/Animable.h index 5779636f8..6da6a2d5a 100644 --- a/src/SceneGraph/Animable.h +++ b/src/SceneGraph/Animable.h @@ -229,14 +229,14 @@ template class Animable: public AbstractGrouped * @deprecated Use @ref Magnum::SceneGraph::Animable::animables() "animables()" * instead. */ - AnimableGroup* group() { return animables(); } + CORRADE_DEPRECATED("use animables() instead") AnimableGroup* group() { return animables(); } /** * @copydoc animables() * @deprecated Use @ref Magnum::SceneGraph::Animable::animables() "animables()" * instead. */ - const AnimableGroup* group() const { return animables(); } + CORRADE_DEPRECATED("use animables() instead") const AnimableGroup* group() const { return animables(); } #endif protected: diff --git a/src/Swizzle.h b/src/Swizzle.h index ecf717e8a..84b176aff 100644 --- a/src/Swizzle.h +++ b/src/Swizzle.h @@ -41,7 +41,7 @@ namespace Magnum { @deprecated Use @ref Magnum::Math::swizzle() "Math::swizzle()" instead. */ #ifdef DOXYGEN_GENERATING_OUTPUT -template constexpr typename Math::Implementation::TypeForSize::Type swizzle(const T& vector); +template constexpr CORRADE_DEPRECATED("use Math::swizzle() instead") typename Math::Implementation::TypeForSize::Type swizzle(const T& vector); #else using Math::swizzle; #endif diff --git a/src/Text/TextRenderer.h b/src/Text/TextRenderer.h index 53ed366d6..5f29e3270 100644 --- a/src/Text/TextRenderer.h +++ b/src/Text/TextRenderer.h @@ -3,24 +3,24 @@ #include "Text/Renderer.h" +#ifdef MAGNUM_BUILD_DEPRECATED namespace Magnum { namespace Text { -#ifdef MAGNUM_BUILD_DEPRECATED /** @copybrief Renderer2D @deprecated Use @ref Magnum::Text::Renderer2D "Renderer2D" instead. */ -typedef Renderer<2> TextRenderer2D; +typedef CORRADE_DEPRECATED("use Renderer2D instead") Renderer<2> TextRenderer2D; /** @copybrief Renderer3D @deprecated Use @ref Magnum::Text::Renderer3D "Renderer3D" instead. */ -typedef Renderer<3> TextRenderer3D; +typedef CORRADE_DEPRECATED("use Renderer2D instead") Renderer<3> TextRenderer3D; + +}} #else #error #endif -}} - #endif