diff --git a/src/Magnum/AbstractFramebuffer.h b/src/Magnum/AbstractFramebuffer.h index b3a16d372..9b005f8a2 100644 --- a/src/Magnum/AbstractFramebuffer.h +++ b/src/Magnum/AbstractFramebuffer.h @@ -72,17 +72,17 @@ typedef Containers::EnumSet FramebufferClearMask; enum class FramebufferBlit: GLbitfield { #ifdef MAGNUM_BUILD_DEPRECATED /** @copydoc FramebufferBlit::Color - * @deprecated Use @ref Magnum::FramebufferBlit::Color "FramebufferBlit::Color" instead. + * @deprecated Use @ref FramebufferBlit::Color instead. */ ColorBuffer = GL_COLOR_BUFFER_BIT, /** @copydoc FramebufferBlit::Depth - * @deprecated Use @ref Magnum::FramebufferBlit::Depth "FramebufferBlit::Depth" instead. + * @deprecated Use @ref FramebufferBlit::Depth instead. */ DepthBuffer = GL_DEPTH_BUFFER_BIT, /** @copydoc FramebufferBlit::Stencil - * @deprecated Use @ref Magnum::FramebufferBlit::Stencil "FramebufferBlit::Stencil" instead. + * @deprecated Use @ref FramebufferBlit::Stencil instead. */ StencilBuffer = GL_STENCIL_BUFFER_BIT, #endif diff --git a/src/Magnum/AbstractShaderProgram.h b/src/Magnum/AbstractShaderProgram.h index c69eb3a50..c7fa2e4fd 100644 --- a/src/Magnum/AbstractShaderProgram.h +++ b/src/Magnum/AbstractShaderProgram.h @@ -180,17 +180,15 @@ bindFragmentDataLocationIndexed(NormalOutput, 1, "normal"); @see @ref Mesh::maxVertexAttributes(), @ref AbstractFramebuffer::maxDrawBuffers() @requires_gl30 Extension @extension{EXT,gpu_shader4} for using - @ref Magnum::AbstractShaderProgram::bindFragmentDataLocation() "bindFragmentDataLocation()". + @ref bindFragmentDataLocation(). @requires_gl33 Extension @extension{ARB,blend_func_extended} for using - @ref Magnum::AbstractShaderProgram::bindFragmentDataLocationIndexed() "bindFragmentDataLocationIndexed()". + @ref bindFragmentDataLocationIndexed(). @requires_gl33 Extension @extension{ARB,explicit_attrib_location} for explicit attribute location instead of using - @ref Magnum::AbstractShaderProgram::bindAttributeLocation() "bindAttributeLocation()", - @ref Magnum::AbstractShaderProgram::bindFragmentDataLocation() "bindFragmentDataLocation()" - or @ref Magnum::AbstractShaderProgram::bindFragmentDataLocationIndexed() "bindFragmentDataLocationIndexed()". + @ref bindAttributeLocation(), @ref bindFragmentDataLocation() or + @ref bindFragmentDataLocationIndexed(). @requires_gles30 Explicit location specification of input attributes is not - supported in OpenGL ES 2.0, use @ref Magnum::AbstractShaderProgram::bindAttributeLocation() "bindAttributeLocation()" - instead. + supported in OpenGL ES 2.0, use @ref bindAttributeLocation() instead. @requires_gles30 Multiple fragment shader outputs are not available in OpenGL ES 2.0, similar functionality is available in extension @es_extension{NV,draw_buffers}. @@ -228,11 +226,9 @@ Int normalMatrixUniform = uniformLocation("normalMatrix"); @see @ref maxUniformLocations() @requires_gl43 Extension @extension{ARB,explicit_uniform_location} for - explicit uniform location instead of using - @ref Magnum::AbstractShaderProgram::uniformLocation() "uniformLocation()". + explicit uniform location instead of using @ref uniformLocation(). @requires_gles31 Explicit uniform location is not supported in OpenGL ES 3.0 - and older. Use @ref Magnum::AbstractShaderProgram::uniformLocation() "uniformLocation()" - instead. + and older. Use @ref uniformLocation() instead. @anchor AbstractShaderProgram-texture-units ### Specifying texture binding units @@ -262,9 +258,9 @@ setUniform(uniformLocation("specularTexture"), 1); @see @ref Shader::maxTextureImageUnits() @requires_gl42 Extension @extension{ARB,shading_language_420pack} for explicit texture binding unit instead of using - @ref Magnum::AbstractShaderProgram::setUniform(Int, const T&) "setUniform(Int, Int)". + @ref setUniform(Int, const T&) "setUniform(Int, Int)". @requires_gles31 Explicit texture binding unit is not supported in OpenGL ES - 3.0 and older. Use @ref Magnum::AbstractShaderProgram::setUniform(Int, const T&) "setUniform(Int, Int)" + 3.0 and older. Use @ref setUniform(Int, const T&) "setUniform(Int, Int)" instead. @anchor AbstractShaderProgram-transform-feedback @@ -306,11 +302,10 @@ setTransformFeedbackOutputs({ @ref TransformFeedback::maxSeparateComponents() @requires_gl40 Extension @extension{ARB,transform_feedback3} for using `gl_NextBuffer` or `gl_SkipComponents#` names in - @ref Magnum::AbstractShaderProgram::setTransformFeedbackOutputs() "setTransformFeedbackOutputs()" - function + @ref setTransformFeedbackOutputs() function. @requires_gl44 Extension @extension{ARB,enhanced_layouts} for explicit transform feedback output specification instead of using - @ref Magnum::AbstractShaderProgram::setTransformFeedbackOutputs() "setTransformFeedbackOutputs()" + @ref setTransformFeedbackOutputs(). @requires_gl Explicit transform feedback output specification is not available in OpenGL ES. @@ -340,35 +335,24 @@ See @ref types for more information, only types with GLSL equivalent can be used also @ref Attribute::DataType enum for additional type options. @requires_gl30 Extension @extension{EXT,gpu_shader4} is required when using - integer attributes (i.e. @ref Magnum::UnsignedInt "UnsignedInt", - @ref Magnum::Int "Int", @ref Magnum::Vector2ui "Vector2ui", - @ref Magnum::Vector2i "Vector2i", @ref Magnum::Vector3ui "Vector3ui", - @ref Magnum::Vector3i "Vector3i", @ref Magnum::Vector4ui "Vector4ui" and - @ref Magnum::Vector4i "Vector4i") or unsigned integer uniforms (i.e. - @ref Magnum::UnsignedInt "UnsignedInt", @ref Magnum::Vector2ui "Vector2ui", - @ref Magnum::Vector3ui "Vector3ui" and @ref Magnum::Vector4ui "Vector4ui"). + integer attributes (i.e. @ref UnsignedInt, @ref Int, @ref Vector2ui, + @ref Vector2i, @ref Vector3ui, @ref Vector3i, @ref Vector4ui and + @ref Vector4i) or unsigned integer uniforms (i.e. @ref UnsignedInt, + @ref Vector2ui, @ref Vector3ui and @ref Vector4ui). @requires_gl40 Extension @extension{ARB,gpu_shader_fp64} is required when - using double uniforms (i.e. @ref Magnum::Double "Double", - @ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d", - @ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2x2d "Matrix2x2d", - @ref Magnum::Matrix3x3d "Matrix3x3d", @ref Magnum::Matrix4x4d "Matrix4x4d", - @ref Magnum::Matrix2x3d "Matrix2x3d", @ref Magnum::Matrix3x2d "Matrix3x2d", - @ref Magnum::Matrix2x4d "Matrix2x4d", @ref Magnum::Matrix4x2d "Matrix4x2d", - @ref Magnum::Matrix3x4d "Matrix3x4d" and @ref Magnum::Matrix4x3d "Matrix4x3d"). + using double uniforms (i.e. @ref Double, @ref Vector2d, @ref Vector3d, + @ref Vector4d, @ref Matrix2x2d, @ref Matrix3x3d, @ref Matrix4x4d, + @ref Matrix2x3d, @ref Matrix3x2d, @ref Matrix2x4d, @ref Matrix4x2d, + @ref Matrix3x4d and @ref Matrix4x3d). @requires_gl41 Extension @extension{ARB,vertex_attrib_64bit} is required when - using double attributes (i.e. @ref Magnum::Double "Double", - @ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d", - @ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2x2d "Matrix2x2d", - @ref Magnum::Matrix3x3d "Matrix3x3d", @ref Magnum::Matrix4x4d "Matrix4x4d", - @ref Magnum::Matrix2x3d "Matrix2x3d", @ref Magnum::Matrix3x2d "Matrix3x2d", - @ref Magnum::Matrix2x4d "Matrix2x4d", @ref Magnum::Matrix4x2d "Matrix4x2d", - @ref Magnum::Matrix3x4d "Matrix3x4d" and @ref Magnum::Matrix4x3d "Matrix4x3d"). - + using double attributes (i.e. @ref Double, @ref Vector2d, @ref Vector3d, + @ref Vector4d, @ref Matrix2x2d, @ref Matrix3x3d, @ref Matrix4x4d, + @ref Matrix2x3d, @ref Matrix3x2d, @ref Matrix2x4d, @ref Matrix4x2d, + @ref Matrix3x4d and @ref Matrix4x3d). @requires_gles30 Integer attributes, unsigned integer uniforms and non-square - matrix attributes and uniforms (i.e. @ref Magnum::Matrix2x3 "Matrix2x3", - @ref Magnum::Matrix3x2 "Matrix3x2", @ref Magnum::Matrix2x4 "Matrix2x4", - @ref Magnum::Matrix4x2d "Matrix4x2", @ref Magnum::Matrix3x4 "Matrix3x4" and - @ref Magnum::Matrix4x3 "Matrix4x3") are not available in OpenGL ES 2.0. + matrix attributes and uniforms (i.e. @ref Matrix2x3, @ref Matrix3x2, + @ref Matrix2x4, @ref Matrix4x2, @ref Matrix3x4 and @ref Matrix4x3) are not + available in OpenGL ES 2.0. @requires_gl Double attributes and uniforms are not available in OpenGL ES. @anchor AbstractShaderProgram-performance-optimization @@ -636,7 +620,7 @@ class MAGNUM_EXPORT AbstractShaderProgram: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @brief Use shader for rendering - * @deprecated Use @ref Magnum::Mesh::draw(AbstractShaderProgram&) "Mesh::draw(AbstractShaderProgram&)" instead. + * @deprecated Use @ref Mesh::draw(AbstractShaderProgram&) instead. */ void use(); #endif diff --git a/src/Magnum/AbstractTexture.h b/src/Magnum/AbstractTexture.h index 688a5aea7..a3630e12f 100644 --- a/src/Magnum/AbstractTexture.h +++ b/src/Magnum/AbstractTexture.h @@ -145,8 +145,7 @@ class MAGNUM_EXPORT AbstractTexture: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief Shader::maxCombinedTextureImageUnits() - * @deprecated Use @ref Magnum::Shader::maxCombinedTextureImageUnits() "Shader::maxCombinedTextureImageUnits()" - * instead. + * @deprecated Use @ref Shader::maxCombinedTextureImageUnits() instead. */ static CORRADE_DEPRECATED("use Shader::maxCombinedTextureImageUnits() instead") Int maxLayers(); #endif diff --git a/src/Magnum/Audio/Source.h b/src/Magnum/Audio/Source.h index 293201f56..edab1faf1 100644 --- a/src/Magnum/Audio/Source.h +++ b/src/Magnum/Audio/Source.h @@ -389,7 +389,8 @@ class MAGNUM_AUDIO_EXPORT Source { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief play(const std::vector>&) - * @deprecated Use @ref Magnum::Audio::Source::play(const std::vector>&) "play(const std::vector>&)" instead. + * @deprecated Use @ref play(const std::vector>&) + * instead. */ static CORRADE_DEPRECATED("use play(const std::vector>&) instead") void play(const std::vector& sources); #endif @@ -410,7 +411,8 @@ class MAGNUM_AUDIO_EXPORT Source { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief pause(const std::vector>&) - * @deprecated Use @ref Magnum::Audio::Source::pause(const std::vector>&) "pause(const std::vector>&)" instead. + * @deprecated Use @ref pause(const std::vector>&) + * instead. */ static CORRADE_DEPRECATED("use pause(const std::vector>&) instead") void pause(const std::vector& sources); #endif @@ -431,7 +433,8 @@ class MAGNUM_AUDIO_EXPORT Source { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief stop(const std::vector>&) - * @deprecated Use @ref Magnum::Audio::Source::stop(const std::vector>&) "stop(const std::vector>&)" instead. + * @deprecated Use @ref stop(const std::vector>&) + * instead. */ static CORRADE_DEPRECATED("use stop(const std::vector>&) instead") void stop(const std::vector& sources); #endif @@ -452,7 +455,8 @@ class MAGNUM_AUDIO_EXPORT Source { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rewind(const std::vector>&) - * @deprecated Use @ref Magnum::Audio::Source::rewind(const std::vector>&) "rewind(const std::vector>&)" instead. + * @deprecated Use @ref rewind(const std::vector>&) + * instead. */ static CORRADE_DEPRECATED("use rewind(const std::vector>&) instead") void rewind(const std::vector& sources); #endif diff --git a/src/Magnum/Buffer.h b/src/Magnum/Buffer.h index f805ed620..74a81fd5b 100644 --- a/src/Magnum/Buffer.h +++ b/src/Magnum/Buffer.h @@ -58,16 +58,16 @@ enum class BufferUsage: GLenum { /** * Set once as output from an OpenGL command and used infequently for * drawing. - * @requires_gles30 Only @ref Magnum::BufferUsage::StreamDraw "BufferUsage::StreamDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::StreamDraw is available in + * OpenGL ES 2.0. */ StreamRead = GL_STREAM_READ, /** * Set once as output from an OpenGL command and used infrequently for * drawing or copying to other buffers. - * @requires_gles30 Only @ref Magnum::BufferUsage::StreamDraw "BufferUsage::StreamDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::StreamDraw is available in + * OpenGL ES 2.0. */ StreamCopy = GL_STREAM_COPY, #endif @@ -79,16 +79,16 @@ enum class BufferUsage: GLenum { /** * Set once as output from an OpenGL command and queried many times by the * application. - * @requires_gles30 Only @ref Magnum::BufferUsage::StaticDraw "BufferUsage::StaticDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::StaticDraw is available in + * OpenGL ES 2.0. */ StaticRead = GL_STATIC_READ, /** * Set once as output from an OpenGL command and used frequently for * drawing or copying to other buffers. - * @requires_gles30 Only @ref Magnum::BufferUsage::StaticDraw "BufferUsage::StaticDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::StaticDraw is available in + * OpenGL ES 2.0. */ StaticCopy = GL_STATIC_COPY, #endif @@ -103,16 +103,16 @@ enum class BufferUsage: GLenum { /** * Updated frequently as output from OpenGL command and queried many times * from the application. - * @requires_gles30 Only @ref Magnum::BufferUsage::DynamicDraw "BufferUsage::DynamicDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::DynamicDraw is available in + * OpenGL ES 2.0. */ DynamicRead = GL_DYNAMIC_READ, /** * Updated frequently as output from OpenGL command and used frequently for * drawing or copying to other images. - * @requires_gles30 Only @ref Magnum::BufferUsage::DynamicDraw "BufferUsage::DynamicDraw" - * is available in OpenGL ES 2.0. + * @requires_gles30 Only @ref BufferUsage::DynamicDraw is available in + * OpenGL ES 2.0. */ DynamicCopy = GL_DYNAMIC_COPY #endif @@ -332,9 +332,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copydoc TargetHint::Array - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::Array "TargetHint::Array" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::Array instead. */ Array = GL_ARRAY_BUFFER, #endif @@ -353,17 +352,15 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifndef MAGNUM_TARGET_GLES2 /** * @copydoc TargetHint::CopyRead - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::CopyRead "TargetHint::CopyRead" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::CopyRead instead. */ CopyRead = GL_COPY_READ_BUFFER, /** * @copydoc TargetHint::CopyWrite - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::CopyWrite "TargetHint::CopyWrite" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::CopyWrite instead. */ CopyWrite = GL_COPY_WRITE_BUFFER, #endif @@ -371,43 +368,38 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifndef MAGNUM_TARGET_GLES2 /** * @copydoc TargetHint::DispatchIndirect - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::DispatchIndirect "TargetHint::DispatchIndirect" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::DispatchIndirect instead. */ DispatchIndirect = GL_DISPATCH_INDIRECT_BUFFER, /** * @copydoc TargetHint::DrawIndirect - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::DrawIndirect "TargetHint::DrawIndirect" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::DrawIndirect instead. */ DrawIndirect = GL_DRAW_INDIRECT_BUFFER, #endif /** * @copydoc TargetHint::ElementArray - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::ElementArray "TargetHint::ElementArray" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::ElementArray instead. */ ElementArray = GL_ELEMENT_ARRAY_BUFFER, #ifndef MAGNUM_TARGET_GLES2 /** * @copydoc TargetHint::PixelPack - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::PixelPack "TargetHint::PixelPack" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::PixelPack instead. */ PixelPack = GL_PIXEL_PACK_BUFFER, /** * @copydoc TargetHint::PixelUnpack - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::PixelUnpack "TargetHint::PixelUnpack" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::PixelUnpack instead. */ PixelUnpack = GL_PIXEL_UNPACK_BUFFER, #endif @@ -426,9 +418,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #if defined(MAGNUM_BUILD_DEPRECATED) && !defined(MAGNUM_TARGET_GLES) /** * @copydoc TargetHint::Texture - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::Texture "TargetHint::Texture" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::Texture instead. */ Texture = GL_TEXTURE_BUFFER, #endif @@ -436,9 +427,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #if defined(MAGNUM_BUILD_DEPRECATED) && !defined(MAGNUM_TARGET_GLES2) /** * @copydoc TargetHint::TransformFeedback - * @deprecated For @ref Magnum::Buffer::setTargetHint() "setTargetHint()" - * only, use @ref Magnum::Buffer::TargetHint::TransformFeedback "TargetHint::TransformFeedback" - * instead. + * @deprecated For @ref setTargetHint() only, use + * @ref TargetHint::TransformFeedback instead. */ TransformFeedback = GL_TRANSFORM_FEEDBACK_BUFFER, #endif @@ -458,7 +448,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief BufferUsage - * @deprecated Use @ref Magnum::BufferUsage "BufferUsage" instead. + * @deprecated Use @ref BufferUsage instead. */ typedef CORRADE_DEPRECATED("use BufferUsage instead") BufferUsage Usage; #endif @@ -469,15 +459,15 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @see @ref map(MapAccess), @ref mapSub() * @requires_es_extension Extension @es_extension{OES,mapbuffer} or * @es_extension{CHROMIUM,map_sub} - * @deprecated_gl Prefer to use @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" + * @deprecated_gl Prefer to use @ref map(GLintptr, GLsizeiptr, MapFlags) * instead, as it has more complete set of features. */ enum class MapAccess: GLenum { #ifndef MAGNUM_TARGET_GLES /** * Map buffer for reading only. - * @requires_gl Only @ref Magnum::Buffer::MapAccess "MapAccess::WriteOnly" - * is available in OpenGL ES. + * @requires_gl Only @ref MapAccess::WriteOnly is available in + * OpenGL ES. */ ReadOnly = GL_READ_ONLY, #endif @@ -490,8 +480,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { /** * Map buffer for both reading and writing. - * @requires_gl Only @ref Magnum::Buffer::MapAccess "MapAccess::WriteOnly" - * is available in OpenGL ES. + * @requires_gl Only @ref MapAccess::WriteOnly is available in + * OpenGL ES. */ ReadWrite = GL_READ_WRITE #endif @@ -657,11 +647,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref maxShaderStorageBindings(), @ref maxUniformBindings(), * @fn_gl{BindBufferBase} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. */ static void unbind(Target target, UnsignedInt index); @@ -680,11 +670,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref maxShaderStorageBindings(), @ref maxUniformBindings(), * @fn_gl{BindBuffersBase} or @fn_gl{BindBufferBase} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. */ static void unbind(Target target, UnsignedInt firstIndex, std::size_t count); @@ -710,11 +700,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref uniformOffsetAlignment(), @ref TransformFeedback::attachBuffers(), * @fn_gl{BindBuffersRange} or @fn_gl{BindBufferRange} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. */ static void bind(Target target, UnsignedInt firstIndex, std::initializer_list> buffers); @@ -736,11 +726,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref TransformFeedback::attachBuffers(), @fn_gl{BindBuffersBase} * or @fn_gl{BindBufferBase} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. */ static void bind(Target target, UnsignedInt firstIndex, std::initializer_list buffers); @@ -780,8 +770,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief Buffer(TargetHint) - * @deprecated Use @ref Magnum::Buffer::Buffer(Magnum::Buffer::TargetHint) "Buffer(TargetHint)" - * instead. + * @deprecated Use @ref Buffer(TargetHint) instead. */ CORRADE_DEPRECATED("use Buffer(TargetHint) instead") explicit Buffer(Target targetHint): Buffer{static_cast(targetHint)} {} #endif @@ -868,8 +857,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief setTargetHint(TargetHint) - * @deprecated Use @ref Magnum::Buffer::setTargetHint(Magnum::Buffer::TargetHint) "setTargetHint(TargetHint)" - * instead. + * @deprecated Use @ref setTargetHint(TargetHint) instead. */ CORRADE_DEPRECATED("use setTargetHint(TargetHint) instead") Buffer& setTargetHint(Target hint) { return setTargetHint(static_cast(hint)); @@ -893,11 +881,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref uniformOffsetAlignment(), @ref TransformFeedback::attachBuffer(), * @fn_gl{BindBufferRange} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. * @todo State tracking for indexed binding */ Buffer& bind(Target target, UnsignedInt index, GLintptr offset, GLsizeiptr size); @@ -915,11 +903,11 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @ref maxUniformBindings(), @ref TransformFeedback::attachBuffer(), * @fn_gl{BindBufferBase} * @requires_gl30 No form of indexed buffer binding is available in - * OpenGL 2.1, see particular @ref Magnum::Buffer::Target "Target" - * values for version/extension requirements. + * OpenGL 2.1, see particular @ref Target values for + * version/extension requirements. * @requires_gles30 No form of indexed buffer binding is available in - * OpenGL ES 2.0, see particular @ref Magnum::Buffer::Target "Target" - * values for version requirements. + * OpenGL ES 2.0, see particular @ref Target values for version + * requirements. */ Buffer& bind(Target target, UnsignedInt index); #endif @@ -952,8 +940,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * with @def_gl{BUFFER_SIZE}, then @fn_gl2{GetNamedBufferSubData,GetBufferSubData}, * @fn_gl_extension{GetNamedBufferSubData,EXT,direct_state_access}, * eventually @fn_gl{GetBufferSubData} - * @requires_gl Buffer data queries are not available in OpenGL ES. - * Use @ref Magnum::Buffer::map() "map()" instead. + * @requires_gl Buffer data queries are not available in OpenGL ES. Use + * @ref map() instead. */ template Containers::Array data(); @@ -970,8 +958,8 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @fn_gl2{GetNamedBufferSubData,GetBufferSubData}, * @fn_gl_extension{GetNamedBufferSubData,EXT,direct_state_access}, * eventually @fn_gl{BindBuffer} and @fn_gl{GetBufferSubData} - * @requires_gl Buffer data queries are not available in OpenGL ES. - * Use @ref Magnum::Buffer::map() "map()" instead. + * @requires_gl Buffer data queries are not available in OpenGL ES. Use + * @ref map() instead. */ template Containers::Array subData(GLintptr offset, GLsizeiptr size); #endif @@ -1068,9 +1056,9 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @fn_gl_extension{MapNamedBuffer,EXT,direct_state_access}, * eventually @fn_gl{BindBuffer} and @fn_gl{MapBuffer} * @requires_es_extension Extension @es_extension{OES,mapbuffer} in - * OpenGL ES 2.0, use @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" - * in OpenGL ES 3.0 instead. - * @deprecated_gl Prefer to use @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" + * OpenGL ES 2.0, use @ref map(GLintptr, GLsizeiptr, MapFlags) in + * OpenGL ES 3.0 instead. + * @deprecated_gl Prefer to use @ref map(GLintptr, GLsizeiptr, MapFlags) * instead, as it has more complete set of features. */ void* map(MapAccess access); @@ -1093,10 +1081,9 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * @see @ref unmapSub(), @ref setTargetHint(), * @fn_gl_extension{MapBufferSubData,CHROMIUM,map_sub} * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" - * instead. + * @ref map(GLintptr, GLsizeiptr, MapFlags) instead. * @requires_es_extension Extension @es_extension{CHROMIUM,map_sub} - * @deprecated_gl Prefer to use @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" + * @deprecated_gl Prefer to use @ref map(GLintptr, GLsizeiptr, MapFlags) * instead, as it has more complete set of features. */ void* mapSub(GLintptr offset, GLsizeiptr length, MapAccess access); @@ -1185,8 +1172,7 @@ class MAGNUM_EXPORT Buffer: public AbstractObject { * invalidating the pointer returned by the function. * @see @fn_gl_extension{UnmapBufferSubData,CHROMIUM,map_sub} * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::Buffer::map(GLintptr, GLsizeiptr, MapFlags) "map(GLintptr, GLsizeiptr, MapFlags)" - * instead. + * @ref map(GLintptr, GLsizeiptr, MapFlags) instead. * @requires_es_extension Extension @es_extension{CHROMIUM,map_sub} */ void unmapSub(); diff --git a/src/Magnum/ColorFormat.h b/src/Magnum/ColorFormat.h index 9d0a9db3c..3185491a0 100644 --- a/src/Magnum/ColorFormat.h +++ b/src/Magnum/ColorFormat.h @@ -68,15 +68,13 @@ enum class ColorFormat: GLenum { #ifndef MAGNUM_TARGET_GLES /** * Floating-point green channel. - * @requires_gl Only @ref Magnum::ColorFormat::Red "ColorFormat::Red" is - * available in OpenGL ES. + * @requires_gl Only @ref ColorFormat::Red is available in OpenGL ES. */ Green = GL_GREEN, /** * Floating-point blue channel. - * @requires_gl Only @ref Magnum::ColorFormat::Red "ColorFormat::Red" is - * available in OpenGL ES. + * @requires_gl Only @ref ColorFormat::Red is available in OpenGL ES. */ Blue = GL_BLUE, #endif @@ -86,9 +84,9 @@ enum class ColorFormat: GLenum { * Floating-point luminance channel. The value is used for all RGB * channels. * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::ColorFormat::Red "ColorFormat::Red" instead. + * @ref ColorFormat::Red instead. * @deprecated_gl Included for compatibility reasons only, use - * @ref Magnum::ColorFormat::Red "ColorFormat::Red" instead. + * @ref ColorFormat::Red instead. */ Luminance = GL_LUMINANCE, #endif @@ -111,9 +109,9 @@ enum class ColorFormat: GLenum { * Floating-point luminance and alpha channel. First value is used for all * RGB channels, second value is used for alpha channel. * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::ColorFormat::RG "ColorFormat::RG" instead. + * @ref ColorFormat::RG instead. * @deprecated_gl Included for compatibility reasons only, use - * @ref Magnum::ColorFormat::RG "ColorFormat::RG" instead. + * @ref ColorFormat::RG instead. */ LuminanceAlpha = GL_LUMINANCE_ALPHA, #endif @@ -160,18 +158,16 @@ enum class ColorFormat: GLenum { /** * Integer green channel. * @requires_gl30 Extension @extension{EXT,texture_integer} - * @requires_gl Only @ref Magnum::ColorFormat::RedInteger "ColorFormat::RedInteger" - * is available in OpenGL ES 3.0, only floating-point image data are - * available in OpenGL ES 2.0. + * @requires_gl Only @ref ColorFormat::RedInteger is available in OpenGL ES + * 3.0, only floating-point image data are available in OpenGL ES 2.0. */ GreenInteger = GL_GREEN_INTEGER, /** * Integer blue channel. * @requires_gl30 Extension @extension{EXT,texture_integer} - * @requires_gl Only @ref Magnum::ColorFormat::RedInteger "ColorFormat::RedInteger" - * is available in OpenGL ES 3.0, only floating-point image data are - * available in OpenGL ES 2.0. + * @requires_gl Only @ref ColorFormat::RedInteger is available in OpenGL ES + * 3.0, only floating-point image data are available in OpenGL ES 2.0. */ BlueInteger = GL_BLUE_INTEGER, #endif @@ -206,18 +202,17 @@ enum class ColorFormat: GLenum { /** * Integer BGR. * @requires_gl30 Extension @extension{EXT,texture_integer} - * @requires_gl Only @ref Magnum::ColorFormat::RGBInteger "ColorFormat::RGBInteger" - * is available in OpenGL ES 3.0, only floating-point image data are - * available in OpenGL ES 2.0. + * @requires_gl Only @ref ColorFormat::RGBInteger is available in OpenGL ES + * 3.0, only floating-point image data are available in OpenGL ES 2.0. */ BGRInteger = GL_BGR_INTEGER, /** * Integer BGRA. * @requires_gl30 Extension @extension{EXT,texture_integer} - * @requires_gl Only @ref Magnum::ColorFormat::RGBAInteger "ColorFormat::RGBAInteger" - * is available in OpenGL ES 3.0, only floating-point image data are - * available in OpenGL ES 2.0. + * @requires_gl Only @ref ColorFormat::RGBAInteger is available in OpenGL + * ES 3.0, only floating-point image data are available in OpenGL ES + * 2.0. */ BGRAInteger = GL_BGRA_INTEGER, #endif @@ -286,9 +281,8 @@ enum class ColorType: GLenum { /** * Each component signed byte. * @requires_gl Can't be used for framebuffer reading in OpenGL ES. - * @requires_gles30 For texture data only, only - * @ref Magnum::ColorType::UnsignedByte "ColorType::UnsignedByte" is - * available in OpenGL ES 2.0. + * @requires_gles30 For texture data only, only @ref ColorType::UnsignedByte + * is available in OpenGL ES 2.0. */ Byte = GL_BYTE, #endif @@ -305,9 +299,8 @@ enum class ColorType: GLenum { /** * Each component signed short. * @requires_gl Can't be used for framebuffer reading in OpenGL ES. - * @requires_gles30 For texture data only, only - * @ref Magnum::ColorType::UnsignedShort "ColorType::UnsignedShort" is - * available in OpenGL ES 2.0. + * @requires_gles30 For texture data only, only @ref ColorType::UnsignedShort + * is available in OpenGL ES 2.0. */ Short = GL_SHORT, #endif @@ -323,8 +316,8 @@ enum class ColorType: GLenum { #ifndef MAGNUM_TARGET_GLES2 /** * Each component signed int. - * @requires_gles30 Only @ref Magnum::ColorType::UnsignedInt "ColorType::UnsignedInt" - * is available in OpenGL ES 2.0 in OpenGL ES 2.0 + * @requires_gles30 Only @ref ColorType::UnsignedInt is available in OpenGL + * ES 2.0. */ Int = GL_INT, #endif @@ -372,8 +365,8 @@ enum class ColorType: GLenum { #ifndef MAGNUM_TARGET_GLES /** * BGR, unsigned short, red and blue 5bit, green 6bit. - * @requires_gl Only @ref Magnum::ColorType::UnsignedShort565 "ColorType::UnsignedShort565" - * is available in OpenGL ES. + * @requires_gl Only @ref ColorType::UnsignedShort565 is available in + * OpenGL ES. */ UnsignedShort565Rev = GL_UNSIGNED_SHORT_5_6_5_REV, #endif @@ -415,23 +408,21 @@ enum class ColorType: GLenum { #ifndef MAGNUM_TARGET_GLES /** * RGBA, unsigned int, each component 8bit. - * @requires_gl Use @ref Magnum::ColorType::UnsignedByte "ColorType::UnsignedByte" - * in OpenGL ES instead. + * @requires_gl Use @ref ColorType::UnsignedByte in OpenGL ES instead. */ UnsignedInt8888 = GL_UNSIGNED_INT_8_8_8_8, /** * ABGR, unsigned int, each component 8bit. * @requires_gl Only RGBA component ordering is available in OpenGL ES, see - * @ref Magnum::ColorType::UnsignedInt8888 "ColorType::UnsignedInt8888" - * for more information. + * @ref ColorType::UnsignedInt8888 for more information. */ UnsignedInt8888Rev = GL_UNSIGNED_INT_8_8_8_8_REV, /** * RGBA, unsigned int, each RGB component 10bit, alpha component 2bit. - * @requires_gl Only @ref Magnum::ColorType::UnsignedInt2101010Rev "ColorType::UnsignedInt2101010Rev" - * is available in OpenGL ES. + * @requires_gl Only @ref ColorType::UnsignedInt2101010Rev is available in + * OpenGL ES. */ UnsignedInt1010102 = GL_UNSIGNED_INT_10_10_10_2, #endif @@ -483,8 +474,7 @@ enum class ColorType: GLenum { * Float + unsigned int, depth component 32bit float, 24bit gap, stencil * index 8bit. * @requires_gl30 Extension @extension{ARB,depth_buffer_float} - * @requires_gles30 For texture data only, only - * @ref Magnum::ColorType::UnsignedInt248 "ColorType::UnsignedInt248" + * @requires_gles30 For texture data only, only @ref ColorType::UnsignedInt248 * is available in OpenGL ES 2.0. */ Float32UnsignedInt248Rev = GL_FLOAT_32_UNSIGNED_INT_24_8_REV diff --git a/src/Magnum/Context.h b/src/Magnum/Context.h index e7d28196d..d98b25e33 100644 --- a/src/Magnum/Context.h +++ b/src/Magnum/Context.h @@ -126,8 +126,8 @@ class MAGNUM_EXPORT Context { #ifdef MAGNUM_BUILD_DEPRECATED /** - * @copybrief Context::Flag::RobustAccess - * @deprecated Use @ref Magnum::Context::Flag::RobustAccess "Context::Flag::RobustAccess" instead. + * @copybrief Flag::RobustAccess + * @deprecated Use @ref Flag::RobustAccess instead. */ Robustness = GL_CONTEXT_FLAG_ROBUST_ACCESS_BIT_ARB #endif diff --git a/src/Magnum/CubeMapTexture.h b/src/Magnum/CubeMapTexture.h index 4ba014ba3..bb36982d4 100644 --- a/src/Magnum/CubeMapTexture.h +++ b/src/Magnum/CubeMapTexture.h @@ -368,8 +368,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief imageSize() - * @deprecated Use @ref Magnum::CubeMapTexture::imageSize(Int) "imageSize(Int)" - * instead. + * @deprecated Use @ref imageSize(Int) instead. */ CORRADE_DEPRECATED("use imageSize(Int) instead") Vector2i imageSize(Coordinate, Int level) { return imageSize(level); @@ -528,8 +527,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * * See @ref Texture::setImage() for more information. * @see @ref maxSize() - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTexture::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTexture& setImage(Coordinate coordinate, Int level, TextureFormat internalFormat, const ImageReference2D& image) { @@ -541,8 +539,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { /** @overload * @requires_gles30 Pixel buffer objects are not available in OpenGL ES * 2.0. - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTexture::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTexture& setImage(Coordinate coordinate, Int level, TextureFormat internalFormat, BufferImage2D& image) { @@ -553,8 +550,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { /** @overload * @requires_gles30 Pixel buffer objects are not available in OpenGL ES * 2.0. - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTexture::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTexture& setImage(Coordinate coordinate, Int level, TextureFormat internalFormat, BufferImage2D&& image) { diff --git a/src/Magnum/CubeMapTextureArray.h b/src/Magnum/CubeMapTextureArray.h index ac06c8d23..8b6d361f5 100644 --- a/src/Magnum/CubeMapTextureArray.h +++ b/src/Magnum/CubeMapTextureArray.h @@ -407,8 +407,7 @@ class MAGNUM_EXPORT CubeMapTextureArray: public AbstractTexture { * * See @ref Texture::setImage() for more information. * @see @ref maxSize() - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTextureArray::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTextureArray& setImage(Int level, TextureFormat internalFormat, const ImageReference3D& image) { @@ -417,8 +416,7 @@ class MAGNUM_EXPORT CubeMapTextureArray: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTextureArray::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTextureArray& setImage(Int level, TextureFormat internalFormat, BufferImage3D& image) { @@ -427,8 +425,7 @@ class MAGNUM_EXPORT CubeMapTextureArray: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::CubeMapTextureArray::setStorage() "setStorage()" - * and @ref Magnum::CubeMapTextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ CubeMapTextureArray& setImage(Int level, TextureFormat internalFormat, BufferImage3D&& image) { diff --git a/src/Magnum/DebugMarker.h b/src/Magnum/DebugMarker.h index ef47d0fc1..a3766413d 100644 --- a/src/Magnum/DebugMarker.h +++ b/src/Magnum/DebugMarker.h @@ -37,13 +37,13 @@ namespace Magnum { /** @copybrief DebugMessage -@deprecated Use @ref Magnum::DebugMessage "DebugMessage" instead. +@deprecated Use @ref DebugMessage instead. */ class CORRADE_DEPRECATED("use DebugMessage instead") MAGNUM_EXPORT DebugMarker: public DebugMessage { public: /** * @copybrief DebugMessage::insert() - * @deprecated Use @ref Magnum::DebugMessage::insert() "insert()" instead. + * @deprecated Use @ref DebugMessage::insert() instead. */ static CORRADE_DEPRECATED("use DebugMessage::insert() instead") void mark(const std::string& string) { insert(Source::Application, Type::Marker, 0, DebugOutput::Severity::Notification, string); diff --git a/src/Magnum/DefaultFramebuffer.h b/src/Magnum/DefaultFramebuffer.h index 36deb73c0..3586dbf94 100644 --- a/src/Magnum/DefaultFramebuffer.h +++ b/src/Magnum/DefaultFramebuffer.h @@ -233,8 +233,7 @@ class MAGNUM_EXPORT DefaultFramebuffer: public AbstractFramebuffer { /** * Read from front and back buffer. * @requires_gl In OpenGL ES you must specify either - * @ref Magnum::DefaultFramebuffer::ReadAttachment "ReadAttachment::Front" - * or @ref Magnum::DefaultFramebuffer::ReadAttachment "ReadAttachment::Back". + * @ref ReadAttachment::Front or @ref ReadAttachment::Back. */ FrontAndBack = GL_FRONT_AND_BACK #endif @@ -423,7 +422,7 @@ class MAGNUM_EXPORT DefaultFramebuffer: public AbstractFramebuffer { * @see @ref invalidate(std::initializer_list), * @fn_gl2{InvalidateNamedFramebufferSubData,InvalidateSubFramebuffer}, * eventually @fn_gl{InvalidateSubFramebuffer} - * @requires_gles30 Use @ref Magnum::DefaultFramebuffer::invalidate(std::initializer_list) "invalidate(std::initializer_list)" + * @requires_gles30 Use @ref invalidate(std::initializer_list) * in OpenGL ES 2.0 instead. */ void invalidate(std::initializer_list attachments, const Range2Di& rectangle); diff --git a/src/Magnum/Framebuffer.h b/src/Magnum/Framebuffer.h index b632b90ff..d3b64779c 100644 --- a/src/Magnum/Framebuffer.h +++ b/src/Magnum/Framebuffer.h @@ -180,9 +180,8 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * * @requires_gles30 Combined depth and stencil attachment is * not available in OpenGL ES 2.0. Attach the same object - * to both @ref Magnum::Framebuffer::BufferAttachment::Depth - * "BufferAttachment::Depth" and @ref Magnum::Framebuffer::BufferAttachment::Stencil - * "BufferAttachment::Stencil" instead. + * to both @ref BufferAttachment::Depth and + * @ref BufferAttachment::Stencil instead. * @todo Support this in ES2 (bind to both depth and stencil internally) */ static const BufferAttachment DepthStencil; @@ -479,7 +478,7 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje * @see @ref invalidate(std::initializer_list), * @fn_gl2{InvalidateNamedFramebufferSubData,InvalidateSubFramebuffer}, * eventually @fn_gl{InvalidateSubFramebuffer} - * @requires_gles30 Use @ref Magnum::DefaultFramebuffer::invalidate(std::initializer_list) "invalidate(std::initializer_list)" + * @requires_gles30 Use @ref invalidate(std::initializer_list) * in OpenGL ES 2.0 instead. */ void invalidate(std::initializer_list attachments, const Range2Di& rectangle); @@ -626,7 +625,7 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje #ifndef MAGNUM_TARGET_GLES /** * @copybrief attachTexture() - * @deprecated Use one of @ref Magnum::Framebuffer::attachTexture() "attachTexture()" overloads instead. + * @deprecated Use one of @ref attachTexture() overloads instead. */ Framebuffer& attachTexture1D(BufferAttachment attachment, Texture1D& texture, Int level) { return attachTexture(attachment, texture, level); @@ -635,13 +634,13 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje /** * @copybrief attachTexture() - * @deprecated Use one of @ref Magnum::Framebuffer::attachTexture() "attachTexture()" overloads instead. + * @deprecated Use one of @ref attachTexture() overloads instead. */ Framebuffer& attachTexture2D(BufferAttachment attachment, Texture2D& texture, Int level); /** * @copybrief attachTextureLayer() - * @deprecated Use one of @ref Magnum::Framebuffer::attachTextureLayer() "attachTextureLayer()" overloads instead. + * @deprecated Use one of @ref attachTextureLayer() overloads instead. */ Framebuffer& attachTexture3D(BufferAttachment attachment, Texture3D& texture, Int level, Int layer) { return attachTextureLayer(attachment, texture, level, layer); diff --git a/src/Magnum/Mesh.h b/src/Magnum/Mesh.h index d311a060a..bde2910b0 100644 --- a/src/Magnum/Mesh.h +++ b/src/Magnum/Mesh.h @@ -559,7 +559,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief count() - * @deprecated Use @ref Magnum::Mesh::count() "count()" instead. + * @deprecated Use @ref count() instead. */ CORRADE_DEPRECATED("use count() instead") Int vertexCount() const { return isIndexed() ? 0 : count(); @@ -567,7 +567,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject { /** * @copybrief setCount() - * @deprecated Use @ref Magnum::Mesh::setCount() "setCount()" instead. + * @deprecated Use @ref setCount() instead. */ CORRADE_DEPRECATED("use setCount() instead") Mesh& setVertexCount(Int count) { if(!isIndexed()) setCount(count); @@ -576,7 +576,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject { /** * @copybrief count() - * @deprecated Use @ref Magnum::Mesh::count() "count()" instead. + * @deprecated Use @ref count() instead. */ CORRADE_DEPRECATED("use count() instead") Int indexCount() const { return count(); @@ -584,7 +584,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject { /** * @copybrief setCount() - * @deprecated Use @ref Magnum::Mesh::setCount() "setCount()" instead. + * @deprecated Use @ref setCount() instead. */ CORRADE_DEPRECATED("use setCount() instead") Mesh& setIndexCount(Int count) { return setCount(count); } #endif @@ -809,8 +809,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief draw(AbstractShaderProgram&) - * @deprecated Use @ref Magnum::Mesh::draw(AbstractShaderProgram&) "draw(AbstractShaderProgram&)" - * instead. + * @deprecated Use @ref draw(AbstractShaderProgram&) instead. */ CORRADE_DEPRECATED("use draw(AbstractShaderProgram&) instead") void draw() { #ifndef MAGNUM_TARGET_GLES diff --git a/src/Magnum/MeshTools/CombineIndexedArrays.h b/src/Magnum/MeshTools/CombineIndexedArrays.h index 38a5e50a3..558b19cdc 100644 --- a/src/Magnum/MeshTools/CombineIndexedArrays.h +++ b/src/Magnum/MeshTools/CombineIndexedArrays.h @@ -196,7 +196,7 @@ template std::vector combineIndexedArrays(const std::pa #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief combineIndexedArrays() - * @deprecated Use @ref Magnum::MeshTools::combineIndexedArrays() "combineIndexedArrays(const std::pair&, std::vector&>&...)" instead. + * @deprecated Use @ref combineIndexedArrays() "combineIndexedArrays(const std::pair&, std::vector&>&...)" instead. */ template inline CORRADE_DEPRECATED("use combineIndexedArrays(const std::pair&, std::vector&>&...) instead") std::vector combineIndexedArrays(const std::tuple&, std::vector&>&... indexedArrays) { return combineIndexedArrays(std::make_pair(std::cref(std::get<0>(indexedArrays)), std::ref(std::get<1>(indexedArrays)))...); diff --git a/src/Magnum/MeshTools/CompressIndices.h b/src/Magnum/MeshTools/CompressIndices.h index e31582f90..3a2565afb 100644 --- a/src/Magnum/MeshTools/CompressIndices.h +++ b/src/Magnum/MeshTools/CompressIndices.h @@ -78,8 +78,7 @@ The same as @ref compressIndices(const std::vector&), but this function writes the output to given buffer and calls @ref Mesh::setCount() and @ref Mesh::setIndexBuffer(), thus you don't need to do anything else for mesh index configuration. -@deprecated Use general-purpose - @ref Magnum::MeshTools::compressIndices(const std::vector&) "compressIndices(const std::vector&)" +@deprecated Use general-purpose @ref compressIndices(const std::vector&) instead. */ void MAGNUM_MESHTOOLS_EXPORT compressIndices(Mesh& mesh, Buffer& buffer, BufferUsage usage, const std::vector& indices); diff --git a/src/Magnum/MeshTools/Interleave.h b/src/Magnum/MeshTools/Interleave.h index 0cc96e51c..cca165de9 100644 --- a/src/Magnum/MeshTools/Interleave.h +++ b/src/Magnum/MeshTools/Interleave.h @@ -196,9 +196,7 @@ updates vertex count in the mesh accordingly, so you don't have to call @see @ref compressIndices(), @ref compile() -@deprecated Use general-purpose - @ref Magnum::MeshTools::interleave(const T&...) "interleave(const T&...)" - instead. +@deprecated Use general-purpose @ref interleave(const T&...) instead. */ template CORRADE_DEPRECATED("Use interleave(const T&...) instead") void interleave(Mesh& mesh, Buffer& buffer, BufferUsage usage, const T&... attributes) { if(!mesh.isIndexed()) mesh.setCount(Implementation::AttributeCount{}(attributes...)); @@ -215,9 +213,7 @@ if(!mesh.isIndexed()) mesh.setCount(attribute.size()); buffer.setData(attribute, usage); @endcode -@deprecated Use general-purpose - @ref Magnum::MeshTools::interleave(const T&...) "interleave(const T&...)" - instead. +@deprecated Use general-purpose @ref interleave(const T&...) instead. */ template CORRADE_DEPRECATED("Use interleave(const T&...) instead") typename std::enable_if::value, void>::type interleave(Mesh& mesh, Buffer& buffer, BufferUsage usage, const T& attribute) { if(!mesh.isIndexed()) mesh.setCount(attribute.size()); diff --git a/src/Magnum/MeshTools/RemoveDuplicates.h b/src/Magnum/MeshTools/RemoveDuplicates.h index 62bfca10c..87e3c86da 100644 --- a/src/Magnum/MeshTools/RemoveDuplicates.h +++ b/src/Magnum/MeshTools/RemoveDuplicates.h @@ -166,7 +166,8 @@ template std::vector removeDuplicates(std::vector&, typename Vector::Type) -@deprecated Use @ref Magnum::MeshTools::removeDuplicates(std::vector&, typename Vector::Type) "removeDuplicates(std::vector&, typename Vector::Type)" instead. +@deprecated Use @ref removeDuplicates(std::vector&, typename Vector::Type) + instead. */ template void removeDuplicates(std::vector& indices, std::vector& data, typename Vector::Type epsilon = Math::TypeTraits::epsilon()) { std::vector uniqueIndices; diff --git a/src/Magnum/MeshView.h b/src/Magnum/MeshView.h index dbe57a574..5087de565 100644 --- a/src/Magnum/MeshView.h +++ b/src/Magnum/MeshView.h @@ -141,9 +141,7 @@ class MAGNUM_EXPORT MeshView { * @param first First vertex * @param count Vertex count * - * @deprecated Use @ref Magnum::MeshView::setCount() "setCount()" and - * @ref Magnum::MeshView::setBaseVertex() "setBaseVertex()" - * instead. + * @deprecated Use @ref setCount() and @ref setBaseVertex() instead. */ CORRADE_DEPRECATED("use setCount() and setBaseVertex() instead") MeshView& setVertexRange(Int first, Int count) { return setCount(count), setBaseVertex(first); @@ -175,9 +173,8 @@ class MAGNUM_EXPORT MeshView { * @param start Minimum array index contained in the buffer * @param end Maximum array index contained in the buffer * - * @deprecated Use @ref Magnum::MeshView::setCount() "setCount()" and - * @ref Magnum::MeshView::setIndexRange(Int, UnsignedInt, UnsignedInt) "setIndexRange(Int, UnsignedInt, UnsignedInt)" - * instead. + * @deprecated Use @ref setCount() and + * @ref setIndexRange(Int, UnsignedInt, UnsignedInt) instead. */ CORRADE_DEPRECATED("use setCount() and setIndexRange(Int, UnsignedInt, UnsignedInt) instead") MeshView& setIndexRange(Int first, Int count, UnsignedInt start, UnsignedInt end) { return setCount(count), setIndexRange(first, start, end); @@ -201,9 +198,7 @@ class MAGNUM_EXPORT MeshView { * @param first First index * @param count Index count * - * @deprecated Use @ref Magnum::MeshView::setCount() "setCount()" and - * @ref Magnum::MeshView::setIndexRange(Int) "setIndexRange(Int)" - * instead. + * @deprecated Use @ref setCount() and @ref setIndexRange(Int) instead. */ CORRADE_DEPRECATED("use setCount() and setIndexRange(Int) instead") MeshView& setIndexRange(Int first, Int count) { return setCount(count), setIndexRange(first); @@ -258,8 +253,7 @@ class MAGNUM_EXPORT MeshView { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief draw(AbstractShaderProgram&) - * @deprecated Use @ref Magnum::MeshView::draw(AbstractShaderProgram&) "draw(AbstractShaderProgram&)" - * instead. + * @deprecated Use @ref draw(AbstractShaderProgram&) instead. */ CORRADE_DEPRECATED("use draw(AbstractShaderProgram&) instead") void draw(); #endif diff --git a/src/Magnum/MultisampleTexture.h b/src/Magnum/MultisampleTexture.h index 9c40fe6d5..810f69eaf 100644 --- a/src/Magnum/MultisampleTexture.h +++ b/src/Magnum/MultisampleTexture.h @@ -219,8 +219,7 @@ typedef MultisampleTexture<2> MultisampleTexture2D; @brief Two-dimensional multisample texture array @requires_gl32 Extension @extension{ARB,texture_multisample} -@requires_gl Only @ref Magnum::MultisampleTexture2D "MultisampleTexture2D" is - available in OpenGL ES. +@requires_gl Only @ref MultisampleTexture2D is available in OpenGL ES. */ typedef MultisampleTexture<3> MultisampleTexture2DArray; #endif diff --git a/src/Magnum/PrimitiveQuery.h b/src/Magnum/PrimitiveQuery.h index e47e482aa..034d02926 100644 --- a/src/Magnum/PrimitiveQuery.h +++ b/src/Magnum/PrimitiveQuery.h @@ -87,8 +87,7 @@ class PrimitiveQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief PrimitiveQuery(Target) - * @deprecated Use @ref Magnum::PrimitiveQuery::PrimitiveQuery(Target) "PrimitiveQuery(Target)" - * instead. + * @deprecated Use @ref PrimitiveQuery(Target) instead. */ CORRADE_DEPRECATED("use PrimitiveQuery(Target) instead") explicit PrimitiveQuery() {} #endif @@ -106,8 +105,7 @@ class PrimitiveQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief AbstractQuery::begin() - * @deprecated Use @ref Magnum::AbstractQuery::begin() "begin()" - * instead. + * @deprecated Use @ref begin() instead. */ CORRADE_DEPRECATED("use begin() instead") void begin(Target target) { AbstractQuery::begin(GLenum(target)); diff --git a/src/Magnum/RectangleTexture.h b/src/Magnum/RectangleTexture.h index 193e86e36..6c37fa975 100644 --- a/src/Magnum/RectangleTexture.h +++ b/src/Magnum/RectangleTexture.h @@ -334,8 +334,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture { * * See @ref Texture::setImage() for more information. * @see @ref maxSize() - * @deprecated_gl Prefer to use @ref Magnum::RectangleTexture::setStorage() "setStorage()" - * and @ref Magnum::RectangleTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ RectangleTexture& setImage(TextureFormat internalFormat, const ImageReference2D& image) { @@ -344,8 +343,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::RectangleTexture::setStorage() "setStorage()" - * and @ref Magnum::RectangleTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ RectangleTexture& setImage(TextureFormat internalFormat, BufferImage2D& image) { @@ -354,8 +352,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::RectangleTexture::setStorage() "setStorage()" - * and @ref Magnum::RectangleTexture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ RectangleTexture& setImage(TextureFormat internalFormat, BufferImage2D&& image) { diff --git a/src/Magnum/RenderbufferFormat.h b/src/Magnum/RenderbufferFormat.h index d9cbcdea9..b47bb57aa 100644 --- a/src/Magnum/RenderbufferFormat.h +++ b/src/Magnum/RenderbufferFormat.h @@ -47,7 +47,7 @@ enum class RenderbufferFormat: GLenum { * @requires_gl30 Extension @extension{ARB,texture_rg} * @requires_gl Use exactly specified format in OpenGL ES instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::R8". + * format, e.g. @ref RenderbufferFormat::R8. */ Red = GL_RED, #endif @@ -71,7 +71,7 @@ enum class RenderbufferFormat: GLenum { * @requires_gl30 Extension @extension{ARB,texture_rg} * @requires_gl Use exactly specified format in OpenGL ES instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::RG8". + * format, e.g. @ref RenderbufferFormat::RG8. */ RG = GL_RG, #endif @@ -93,7 +93,7 @@ enum class RenderbufferFormat: GLenum { * RGBA, normalized unsigned, size implementation-dependent. * @requires_gl Use exactly specified format in OpenGL ES 2.0 instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::RGBA8". + * format, e.g. @ref RenderbufferFormat::RGBA8. */ RGBA = GL_RGBA, #endif @@ -341,7 +341,7 @@ enum class RenderbufferFormat: GLenum { /** * RGBA, normalized unsigned, each RGB component 10bit, alpha 2bit. * @requires_gles30 Usable only as internal texture format in OpenGL ES - * 2.0, see @ref Magnum::TextureFormat "TextureFormat::RGB10A2". + * 2.0, see @ref TextureFormat::RGB10A2. */ RGB10A2 = GL_RGB10_A2, @@ -365,7 +365,7 @@ enum class RenderbufferFormat: GLenum { * RGB, float, red and green 11bit, blue 10bit. * @requires_gl30 Extension @extension{EXT,packed_float} * @requires_gl Usable only as internal texture format in OpenGL ES, see - * @ref Magnum::TextureFormat "TextureFormat::R11FG11FB10F". + * @ref TextureFormat::R11FG11FB10F. */ R11FG11FB10F = GL_R11F_G11F_B10F, #endif @@ -389,7 +389,7 @@ enum class RenderbufferFormat: GLenum { * @todo is this allowed in core? * @requires_gl Use exactly specified format in OpenGL ES instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::DepthComponent16". + * format, e.g. @ref RenderbufferFormat::DepthComponent16. */ DepthComponent = GL_DEPTH_COMPONENT, #endif @@ -432,7 +432,7 @@ enum class RenderbufferFormat: GLenum { * Stencil index, size implementation-dependent. * @requires_gl Use exactly specified format in OpenGL ES instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::StencilIndex8". + * format, e.g. @ref RenderbufferFormat::StencilIndex8. */ StencilIndex = GL_STENCIL_INDEX, #endif @@ -471,7 +471,7 @@ enum class RenderbufferFormat: GLenum { * Depth and stencil component, size implementation-dependent. * @requires_gl Use exactly specified format in OpenGL ES instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::RenderbufferFormat "RenderbufferFormat::Depth24Stencil8". + * format, e.g. @ref RenderbufferFormat::Depth24Stencil8. */ DepthStencil = GL_DEPTH_STENCIL, #endif diff --git a/src/Magnum/Renderer.h b/src/Magnum/Renderer.h index dc09ab92b..7e8f4edbb 100644 --- a/src/Magnum/Renderer.h +++ b/src/Magnum/Renderer.h @@ -165,8 +165,7 @@ class MAGNUM_EXPORT Renderer { /** * Offset filled polygons - * @see @ref Magnum::Renderer::Feature "Feature::PolygonOffsetLine", - * @ref Magnum::Renderer::Feature "Feature::PolygonOffsetPoint", + * @see @ref Feature::PolygonOffsetLine, @ref Feature::PolygonOffsetPoint, * @ref setPolygonOffset() */ PolygonOffsetFill = GL_POLYGON_OFFSET_FILL, @@ -174,21 +173,19 @@ class MAGNUM_EXPORT Renderer { #ifndef MAGNUM_TARGET_GLES /** * Offset lines - * @see @ref Magnum::Renderer::Feature "Feature::PolygonOffsetFill", - * @ref Magnum::Renderer::Feature "Feature::PolygonOffsetPoint", + * @see @ref Feature::PolygonOffsetFill, @ref Feature::PolygonOffsetPoint, * @ref setPolygonOffset() - * @requires_gl Only @ref Magnum::Renderer::Feature "Feature::PolygonOffsetFill" - * is available in OpenGL ES. + * @requires_gl Only @ref Feature::PolygonOffsetFill is available + * in OpenGL ES. */ PolygonOffsetLine = GL_POLYGON_OFFSET_LINE, /** * Offset points - * @see @ref Magnum::Renderer::Feature "Feature::PolygonOffsetFill", - * @ref Magnum::Renderer::Feature "Feature::PolygonOffsetLine", + * @see @ref Feature::PolygonOffsetFill, @ref Feature::PolygonOffsetLine, * @ref setPolygonOffset() - * @requires_gl Only @ref Magnum::Renderer::Feature "Feature::PolygonOffsetFill" - * is available in OpenGL ES. + * @requires_gl Only @ref Feature::PolygonOffsetFill is available + * in OpenGL ES. */ PolygonOffsetPoint = GL_POLYGON_OFFSET_POINT, #endif @@ -320,8 +317,8 @@ class MAGNUM_EXPORT Renderer { * * Initial value is `1.0`. * @see @ref Feature::DepthTest, @fn_gl{ClearDepth} - * @requires_gl See @ref Magnum::Renderer::setClearDepth(Float) "setClearDepth(Float)", - * which is available in OpenGL ES. + * @requires_gl See @ref setClearDepth(Float), which is available in + * OpenGL ES. */ static void setClearDepth(Double depth); #endif @@ -385,10 +382,9 @@ class MAGNUM_EXPORT Renderer { * * @see @ref setProvokingVertex() * @requires_gl32 Extension @extension{ARB,provoking_vertex}. Older - * versions behave always like - * @ref Magnum::Renderer::ProvokingVertex "ProvokingVertex::LastVertexConvention". + * versions behave always like @ref ProvokingVertex::LastVertexConvention. * @requires_gl OpenGL ES behaves always like - * @ref Magnum::Renderer::ProvokingVertex "ProvokingVertex::LastVertexConvention". + * @ref ProvokingVertex::LastVertexConvention. */ enum class ProvokingVertex: GLenum { /** @brief Use first vertex of each polygon. */ @@ -413,9 +409,8 @@ class MAGNUM_EXPORT Renderer { * @brief Polygon mode * * @see @ref setPolygonMode() - * @requires_gl OpenGL ES behaves always like @ref Magnum::Renderer::PolygonMode "PolygonMode::Fill". - * See @ref Magnum::Mesh::setPrimitive() "Mesh::setPrimitive()" - * for possible workaround. + * @requires_gl OpenGL ES behaves always like @ref PolygonMode::Fill. + * See @ref Mesh::setPrimitive() for possible workaround. */ enum class PolygonMode: GLenum { /** @@ -441,8 +436,7 @@ class MAGNUM_EXPORT Renderer { * Initial value is @ref PolygonMode::Fill. * @see @fn_gl{PolygonMode} * @requires_gl OpenGL ES behaves always like the default. See - * @ref Magnum::Mesh::setPrimitive() "Mesh::setPrimitive()" for - * possible workaround. + * @ref Mesh::setPrimitive() for possible workaround. */ static void setPolygonMode(PolygonMode mode); #endif diff --git a/src/Magnum/Resource.h b/src/Magnum/Resource.h index cd78b01ab..2d5200503 100644 --- a/src/Magnum/Resource.h +++ b/src/Magnum/Resource.h @@ -208,10 +208,9 @@ class Resource { #ifdef MAGNUM_BUILD_DEPRECATED /** * @overload - * @deprecated Use the explicit @ref Magnum::Resource::operator*() "operator*()" - * or @ref Magnum::Resource::operator->() "operator->()" instead. - * Implicit conversion is no longer allowed if it might throw an - * assertion. + * @deprecated Use the explicit @ref operator*() or @ref operator->() + * instead. Implicit conversion is no longer allowed if it might + * throw an assertion. */ CORRADE_DEPRECATED("use operator*() or operator->() instead") operator U&() { return **this; } #endif diff --git a/src/Magnum/SampleQuery.h b/src/Magnum/SampleQuery.h index 47e3eda9b..a8c05127a 100644 --- a/src/Magnum/SampleQuery.h +++ b/src/Magnum/SampleQuery.h @@ -180,8 +180,7 @@ class SampleQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief SampleQuery(Target) - * @deprecated Use @ref Magnum::SampleQuery::SampleQuery(Target) "SampleQuery(Target)" - * instead. + * @deprecated Use @ref SampleQuery(Target) instead. */ CORRADE_DEPRECATED("use SampleQuery(Target) instead") explicit SampleQuery() {} #endif @@ -199,8 +198,7 @@ class SampleQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief AbstractQuery::begin() - * @deprecated Use @ref Magnum::AbstractQuery::begin() "begin()" - * instead. + * @deprecated Use @ref begin() instead. */ CORRADE_DEPRECATED("use begin() instead") void begin(Target target) { AbstractQuery::begin(GLenum(target)); diff --git a/src/Magnum/Sampler.h b/src/Magnum/Sampler.h index 6a50aec84..d97acb1aa 100644 --- a/src/Magnum/Sampler.h +++ b/src/Magnum/Sampler.h @@ -57,9 +57,8 @@ class MAGNUM_EXPORT Sampler { * @requires_gles30 Extension @es_extension{OES,texture_float_linear} / * @es_extension2{OES,texture_half_float_linear,OES_texture_float_linear} * for linear interpolation of textures with - * @ref Magnum::TextureFormat "TextureFormat::HalfFloat" / - * @ref Magnum::TextureFormat "TextureFormat::Float" in OpenGL - * ES 2.0 + * @ref TextureFormat::HalfFloat / @ref TextureFormat::Float + * in OpenGL ES 2.0 */ Linear = GL_LINEAR }; @@ -83,9 +82,8 @@ class MAGNUM_EXPORT Sampler { * @requires_gles30 Extension @es_extension{OES,texture_float_linear} / * @es_extension2{OES,texture_half_float_linear,OES_texture_float_linear} * for linear interpolation of textures with - * @ref Magnum::TextureFormat "TextureFormat::HalfFloat" / - * @ref Magnum::TextureFormat "TextureFormat::Float" in OpenGL - * ES 2.0 + * @ref TextureFormat::HalfFloat / @ref TextureFormat::Float + * in OpenGL ES 2.0. */ Linear = GL_NEAREST_MIPMAP_LINEAR & ~GL_NEAREST }; @@ -128,9 +126,8 @@ class MAGNUM_EXPORT Sampler { * edge after that. **Unavailable on rectangle textures.** * @requires_gl44 Extension @extension{ARB,texture_mirror_clamp_to_edge}, * @extension{ATI,texture_mirror_once} or @extension{EXT,texture_mirror_clamp} - * @requires_gl Only separate @ref Magnum::Sampler::Wrapping "Wrapping::MirroredRepeat" - * or @ref Magnum::Sampler::Wrapping "Wrapping::ClampToEdge" - * is available in OpenGL ES. + * @requires_gl Only separate @ref Wrapping::MirroredRepeat or + * @ref Wrapping::ClampToEdge is available in OpenGL ES. */ MirrorClampToEdge = GL_MIRROR_CLAMP_TO_EDGE #endif diff --git a/src/Magnum/SceneGraph/AbstractObject.h b/src/Magnum/SceneGraph/AbstractObject.h index 6c3fa2ead..56b8a0a85 100644 --- a/src/Magnum/SceneGraph/AbstractObject.h +++ b/src/Magnum/SceneGraph/AbstractObject.h @@ -207,7 +207,7 @@ template class AbstractObject #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transformationMatrices() - * @deprecated Use @ref Magnum::SceneGraph::AbstractObject::transformationMatrices() "transformationMatrices(const std::vector>>&, const MatrixType&)" instead. + * @deprecated Use @ref transformationMatrices() "transformationMatrices(const std::vector>>&, const MatrixType&)" instead. */ CORRADE_DEPRECATED("use transformationMatrices(const std::vector>>&, const MatrixType&) instead") std::vector transformationMatrices(const std::vector*>& objects, const MatrixType& initialTransformationMatrix = MatrixType()) const; @@ -245,7 +245,7 @@ template class AbstractObject #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief setClean(const std::vector>>&) - * @deprecated Use @ref Magnum::SceneGraph::AbstractObject::setClean(const std::vector>>&) "setClean(const std::vector>>&)" instead. + * @deprecated Use @ref setClean(const std::vector>>&) instead. */ static CORRADE_DEPRECATED("use setClean(const std::vector>>&) instead") void setClean(const std::vector*>& objects); diff --git a/src/Magnum/SceneGraph/AbstractTranslation.h b/src/Magnum/SceneGraph/AbstractTranslation.h index 8962d9674..cd2126553 100644 --- a/src/Magnum/SceneGraph/AbstractTranslation.h +++ b/src/Magnum/SceneGraph/AbstractTranslation.h @@ -84,9 +84,7 @@ class AbstractTranslation: public AbstractTransformation { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslation::translate() "translate()" - * or @ref Magnum::SceneGraph::AbstractTranslation::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") AbstractTranslation& translate(const VectorTypeFor& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h index bce459ae1..44e60f156 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h @@ -72,9 +72,7 @@ template class AbstractBasicTranslationRotation2D: public AbstractBasic #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotation2D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotation2D::rotateLocal() "rotateLocal()" - * instead. + * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") AbstractBasicTranslationRotation2D& rotate(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotate(angle) : rotateLocal(angle); diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h index c0f9e19e2..e37689eb4 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h @@ -76,9 +76,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateLocal() "rotateLocal()" - * instead. + * @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) { return type == TransformationType::Global ? rotate(angle, normalizedAxis) : rotateLocal(angle, normalizedAxis); @@ -116,9 +114,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateX() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateX() "rotateX()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateXLocal() "rotateXLocal()" - * instead. + * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") AbstractBasicTranslationRotation3D& rotateX(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateX(angle) : rotateXLocal(angle); @@ -156,9 +152,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateY() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateY() "rotateY()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateYLocal() "rotateYLocal()" - * instead. + * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") AbstractBasicTranslationRotation3D& rotateY(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateY(angle) : rotateYLocal(angle); @@ -196,9 +190,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateZ() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateZ() "rotateZ()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotation3D::rotateZLocal() "rotateZLocal()" - * instead. + * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") AbstractBasicTranslationRotation3D& rotateZ(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateZ(angle) : rotateZLocal(angle); diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h index 5a39ec41a..f9d81a97f 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h @@ -72,9 +72,7 @@ template class AbstractBasicTranslationRotationScaling2D: public Abstra #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief scale() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotationScaling2D::scale() "scale()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotationScaling2D::scaleLocal() "scaleLocal()" - * instead. + * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") AbstractBasicTranslationRotationScaling2D& scale(const Math::Vector2& vector, TransformationType type) { return type == TransformationType::Global ? scale(vector) : scaleLocal(vector); diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h index 537f0ea99..6f84973db 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h @@ -72,9 +72,7 @@ template class AbstractBasicTranslationRotationScaling3D: public Abstra #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief scale() - * @deprecated Use @ref Magnum::SceneGraph::AbstractTranslationRotationScaling3D::scale() "scale()" - * or @ref Magnum::SceneGraph::AbstractTranslationRotationScaling3D::scaleLocal() "scaleLocal()" - * instead. + * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") AbstractBasicTranslationRotationScaling3D& scale(const Math::Vector3& vector, TransformationType type) { return type == TransformationType::Global ? scale(vector) : scaleLocal(vector); diff --git a/src/Magnum/SceneGraph/DualComplexTransformation.h b/src/Magnum/SceneGraph/DualComplexTransformation.h index 334c0a25c..6ead059a0 100644 --- a/src/Magnum/SceneGraph/DualComplexTransformation.h +++ b/src/Magnum/SceneGraph/DualComplexTransformation.h @@ -112,9 +112,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::DualComplexTransformation::transform() "transform()" - * or @ref Magnum::SceneGraph::DualComplexTransformation::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::DualComplex& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -147,9 +145,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::DualComplexTransformation::translate() "translate()" - * or @ref Magnum::SceneGraph::DualComplexTransformation::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -181,9 +177,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::DualComplexTransformation::rotate() "rotate()" - * or @ref Magnum::SceneGraph::DualComplexTransformation::rotateLocal() "rotateLocal()" - * instead. + * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotate(angle) : rotateLocal(angle); diff --git a/src/Magnum/SceneGraph/DualQuaternionTransformation.h b/src/Magnum/SceneGraph/DualQuaternionTransformation.h index 4bc3a01f6..e4d811be6 100644 --- a/src/Magnum/SceneGraph/DualQuaternionTransformation.h +++ b/src/Magnum/SceneGraph/DualQuaternionTransformation.h @@ -112,9 +112,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::DualQuaternionTransformation::transform() "transform()" - * or @ref Magnum::SceneGraph::DualQuaternionTransformation::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::DualQuaternion& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -146,9 +144,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::DualQuaternionTransformation::translate() "translate()" - * or @ref Magnum::SceneGraph::DualQuaternionTransformation::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -183,9 +179,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::DualQuaternionTransformation::rotate() "rotate()" - * or @ref Magnum::SceneGraph::DualQuaternionTransformation::rotateLocal() "rotateLocal()" - * instead. + * @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) { return type == TransformationType::Global ? rotate(angle, normalizedAxis) : rotateLocal(angle, normalizedAxis); diff --git a/src/Magnum/SceneGraph/MatrixTransformation2D.h b/src/Magnum/SceneGraph/MatrixTransformation2D.h index 22b84f213..79fce8b85 100644 --- a/src/Magnum/SceneGraph/MatrixTransformation2D.h +++ b/src/Magnum/SceneGraph/MatrixTransformation2D.h @@ -89,9 +89,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation2D::transform() "transform()" - * or @ref Magnum::SceneGraph::MatrixTransformation2D::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix3& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -129,9 +127,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation2D::translate() "translate()" - * or @ref Magnum::SceneGraph::MatrixTransformation2D::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -164,9 +160,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation2D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::MatrixTransformation2D::rotateLocal() "rotateLocal()" - * instead. + * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotate(angle) : rotateLocal(angle); @@ -199,9 +193,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief scale() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation2D::scale() "scale()" - * or @ref Magnum::SceneGraph::MatrixTransformation2D::scaleLocal() "scaleLocal()" - * instead. + * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") Object>& scale(const Math::Vector2& vector, TransformationType type) { return type == TransformationType::Global ? scale(vector) : scaleLocal(vector); @@ -236,9 +228,7 @@ template class BasicMatrixTransformation2D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief reflect() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation2D::reflect() "reflect()" - * or @ref Magnum::SceneGraph::MatrixTransformation2D::reflectLocal() "reflectLocal()" - * instead. + * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector2& normal, TransformationType type) { return type == TransformationType::Global ? reflect(normal) : reflectLocal(normal); diff --git a/src/Magnum/SceneGraph/MatrixTransformation3D.h b/src/Magnum/SceneGraph/MatrixTransformation3D.h index f1c05f975..1528372d4 100644 --- a/src/Magnum/SceneGraph/MatrixTransformation3D.h +++ b/src/Magnum/SceneGraph/MatrixTransformation3D.h @@ -94,9 +94,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::transform() "transform()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix4& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -129,9 +127,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::translate() "translate()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -167,9 +163,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::rotateLocal() "rotateLocal()" - * instead. + * @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) { return type == TransformationType::Global ? rotate(angle, normalizedAxis) : rotateLocal(angle, normalizedAxis); @@ -202,9 +196,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateX() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::rotateX() "rotateX()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::rotateXLocal() "rotateXLocal()" - * instead. + * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") Object>& rotateX(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateX(angle) : rotateXLocal(angle); @@ -237,9 +229,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateY() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::rotateY() "rotateY()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::rotateYLocal() "rotateYLocal()" - * instead. + * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") Object>& rotateY(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateY(angle) : rotateYLocal(angle); @@ -272,9 +262,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateZ() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::rotateZ() "rotateZ()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::rotateZLocal() "rotateZLocal()" - * instead. + * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") Object>& rotateZ(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateZ(angle) : rotateZLocal(angle); @@ -307,9 +295,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief scale() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::scale() "scale()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::scaleLocal() "scaleLocal()" - * instead. + * @deprecated Use @ref scale() or @ref scaleLocal() instead. */ CORRADE_DEPRECATED("use scale() or scaleLocal() instead") Object>& scale(const Math::Vector3& vector, TransformationType type) { return type == TransformationType::Global ? scale(vector) : scaleLocal(vector); @@ -343,9 +329,7 @@ template class BasicMatrixTransformation3D: public AbstractBasicTransla #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief reflect() - * @deprecated Use @ref Magnum::SceneGraph::MatrixTransformation3D::reflect() "reflect()" - * or @ref Magnum::SceneGraph::MatrixTransformation3D::reflectLocal() "reflectLocal()" - * instead. + * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector3& normal, TransformationType type) { return type == TransformationType::Global ? reflect(normal) : reflectLocal(normal); diff --git a/src/Magnum/SceneGraph/Object.h b/src/Magnum/SceneGraph/Object.h index 01977015b..700676745 100644 --- a/src/Magnum/SceneGraph/Object.h +++ b/src/Magnum/SceneGraph/Object.h @@ -298,7 +298,8 @@ template class Object: public AbstractObject>>&, const MatrixType&)" instead. + * @deprecated Use @ref transformationMatrices() "transformationMatrices(const std::vector>>&, const MatrixType&)" + * instead. */ CORRADE_DEPRECATED("use transformationMatrices(const std::vector>>&, const MatrixType&) instead") std::vector transformationMatrices(const std::vector*>& objects, const MatrixType& initialTransformationMatrix = MatrixType()) const; @@ -326,7 +327,8 @@ template class Object: public AbstractObject>>, const typename Transformation::DataType&)" instead. + * @deprecated Use @ref transformations() "transformations(std::vector>>, const typename Transformation::DataType&)" + * instead. */ CORRADE_DEPRECATED("use transformations(std::vector>>, const typename Transformation::DataType&) instead") std::vector transformations(const std::vector*>& objects, const typename Transformation::DataType& initialTransformation = typename Transformation::DataType()) const; @@ -360,7 +362,8 @@ template class Object: public AbstractObject>>) - * @deprecated Use @ref Magnum::SceneGraph::Object::setClean(std::vector>>) "setClean(std::vector>>)" instead. + * @deprecated Use @ref setClean(std::vector>>) + * instead. */ CORRADE_DEPRECATED("use setClean(std::vector>>) instead") static void setClean(const std::vector*>& objects); diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h index 40a57d381..b0f7f1e60 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h @@ -117,9 +117,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation2D::transform() "transform()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation2D::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix3& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -152,9 +150,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation2D::translate() "translate()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation2D::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector2& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -188,9 +184,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation2D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation2D::rotateLocal() "rotateLocal()" - * instead. + * @deprecated Use @ref rotate() or @ref rotateLocal() instead. */ CORRADE_DEPRECATED("use rotate() or rotateLocal() instead") Object>& rotate(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotate(angle) : rotateLocal(angle); @@ -224,9 +218,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief reflect() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation2D::reflect() "reflect()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation2D::reflectLocal() "reflectLocal()" - * instead. + * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectInternal() instead") Object>& reflect(const Math::Vector2& normal, TransformationType type) { return type == TransformationType::Global ? reflect(normal) : reflectLocal(normal); diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h index b3164710a..443299fc6 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h @@ -116,9 +116,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief transform() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::transform() "transform()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::transformLocal() "transformLocal()" - * instead. + * @deprecated Use @ref transform() or @ref transformLocal() instead. */ CORRADE_DEPRECATED("use transform() or transformLocal() instead") Object>& transform(const Math::Matrix4& transformation, TransformationType type) { return type == TransformationType::Global ? transform(transformation) : transformLocal(transformation); @@ -151,9 +149,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief translate() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::translate() "translate()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::translateLocal() "translateLocal()" - * instead. + * @deprecated Use @ref translate() or @ref translateLocal() instead. */ CORRADE_DEPRECATED("use translate() or translateLocal() instead") Object>& translate(const Math::Vector3& vector, TransformationType type) { return type == TransformationType::Global ? translate(vector) : translateLocal(vector); @@ -190,9 +186,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotate() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotate() "rotate()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateLocal() "rotateLocal()" - * instead. + * @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) { return type == TransformationType::Global ? rotate(angle, normalizedAxis) : rotateLocal(angle, normalizedAxis); @@ -225,9 +219,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateX() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateX() "rotateX()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateXLocal() "rotateXLocal()" - * instead. + * @deprecated Use @ref rotateX() or @ref rotateXLocal() instead. */ CORRADE_DEPRECATED("use rotateX() or rotateXLocal() instead") Object>& rotateX(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateX(angle) : rotateXLocal(angle); @@ -260,9 +252,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateY() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateY() "rotateY()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateYLocal() "rotateYLocal()" - * instead. + * @deprecated Use @ref rotateY() or @ref rotateYLocal() instead. */ CORRADE_DEPRECATED("use rotateY() or rotateYLocal() instead") Object>& rotateY(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateY(angle) : rotateYLocal(angle); @@ -295,9 +285,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief rotateZ() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateZ() "rotateZ()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::rotateZLocal() "rotateZLocal()" - * instead. + * @deprecated Use @ref rotateZ() or @ref rotateZLocal() instead. */ CORRADE_DEPRECATED("use rotateZ() or rotateZLocal() instead") Object>& rotateZ(Math::Rad angle, TransformationType type) { return type == TransformationType::Global ? rotateZ(angle) : rotateZLocal(angle); @@ -331,9 +319,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief reflect() - * @deprecated Use @ref Magnum::SceneGraph::RigidMatrixTransformation3D::reflect() "reflect()" - * or @ref Magnum::SceneGraph::RigidMatrixTransformation3D::reflectLocal() "reflectLocal()" - * instead. + * @deprecated Use @ref reflect() or @ref reflectLocal() instead. */ CORRADE_DEPRECATED("use reflect() or reflectLocal() instead") Object>& reflect(const Math::Vector3& normal, TransformationType type) { return type == TransformationType::Global ? reflect(normal) : reflectLocal(normal); diff --git a/src/Magnum/SceneGraph/TranslationTransformation.h b/src/Magnum/SceneGraph/TranslationTransformation.h index d1d8f2dce..5277a77b6 100644 --- a/src/Magnum/SceneGraph/TranslationTransformation.h +++ b/src/Magnum/SceneGraph/TranslationTransformation.h @@ -97,8 +97,7 @@ class TranslationTransformation: public AbstractTranslation>& transform(const VectorTypeFor& transformation, TransformationType) { return transform(transformation); @@ -122,8 +121,7 @@ class TranslationTransformation: public AbstractTranslation>& translate(const VectorTypeFor& vector, TransformationType) { return translate(vector); diff --git a/src/Magnum/Shaders/AbstractVector.h b/src/Magnum/Shaders/AbstractVector.h index a575f6ca1..02925ee7d 100644 --- a/src/Magnum/Shaders/AbstractVector.h +++ b/src/Magnum/Shaders/AbstractVector.h @@ -60,7 +60,7 @@ template class AbstractVector: public AbstractShaderProg enum: Int { /** * Vector texture binding unit - * @deprecated Use @ref Magnum::Shaders::AbstractVector::setVectorTexture() "setVectorTexture()" instead. + * @deprecated Use @ref setVectorTexture() instead. */ VectorTextureLayer = 15 }; diff --git a/src/Magnum/Shaders/Flat.h b/src/Magnum/Shaders/Flat.h index 7173794bc..a6d71011e 100644 --- a/src/Magnum/Shaders/Flat.h +++ b/src/Magnum/Shaders/Flat.h @@ -147,7 +147,7 @@ template class MAGNUM_SHADERS_EXPORT Flat: public Abstra /** * Color texture binding unit. Used only if @ref Flag::Textured is * set. - * @deprecated use @ref Magnum::Shaders::Flat::setTexture() "setTexture()" instead. + * @deprecated use @ref setTexture() instead. */ TextureLayer = 0 }; diff --git a/src/Magnum/Shaders/Phong.h b/src/Magnum/Shaders/Phong.h index 46224a3b3..13f7c9dfd 100644 --- a/src/Magnum/Shaders/Phong.h +++ b/src/Magnum/Shaders/Phong.h @@ -158,24 +158,21 @@ class MAGNUM_SHADERS_EXPORT Phong: public AbstractShaderProgram { /** * Ambient texture binding unit. Used only if * @ref Flag::AmbientTexture is set. - * @deprecated Use @ref Magnum::Shaders::Phong::setAmbientTexture() "setAmbientTexture()" - * instead. + * @deprecated Use @ref setAmbientTexture() instead. */ AmbientTextureLayer = 0, /** * Diffuse texture binding unit. Used only if * @ref Flag::DiffuseTexture is set. - * @deprecated Use @ref Magnum::Shaders::Phong::setDiffuseTexture() "setDiffuseTexture()" - * instead. + * @deprecated Use @ref setDiffuseTexture() instead. */ DiffuseTextureLayer = 1, /** * Specular texture binding unit. Used only if * @ref Flag::SpecularTexture is set. - * @deprecated Use @ref Magnum::Shaders::Phong::setSpecularTexture() "setSpecularTexture()" - * instead. + * @deprecated Use @ref setSpecularTexture() instead. */ SpecularTextureLayer = 2 }; diff --git a/src/Magnum/Texture.h b/src/Magnum/Texture.h index e150022ac..39a50a54c 100644 --- a/src/Magnum/Texture.h +++ b/src/Magnum/Texture.h @@ -113,28 +113,28 @@ template class Texture: public AbstractTexture { */ #ifdef DOXYGEN_GENERATING_OUTPUT enum class Target: GLenum { - /** @deprecated Used implicitly in @ref Magnum::Texture1D "Texture1D" class. */ + /** @deprecated Used implicitly in @ref Texture1D class. */ Texture1D = GL_TEXTURE_1D, - /** @deprecated Used implicitly in @ref Magnum::Texture2D "Texture2D" class. */ + /** @deprecated Used implicitly in @ref Texture2D class. */ Texture2D = GL_TEXTURE_2D, - /** @deprecated Used implicitly in @ref Magnum::Texture3D "Texture3D" class. */ + /** @deprecated Used implicitly in @ref Texture3D class. */ Texture3D = GL_TEXTURE_3D, - /** @deprecated Use @ref Magnum::Texture1DArray "Texture1DArray" class instead. */ + /** @deprecated Use @ref Texture1DArray class instead. */ Texture1DArray = GL_TEXTURE_1D_ARRAY, - /** @deprecated Use @ref Magnum::Texture2DArray "Texture2DArray" class instead. */ + /** @deprecated Use @ref Texture2DArray class instead. */ Texture2DArray = GL_TEXTURE_2D_ARRAY, - /** @deprecated Use @ref Magnum::MultisampleTexture2D "MultisampleTexture2D" class instead. */ + /** @deprecated Use @ref MultisampleTexture2D class instead. */ Texture2DMultisample = GL_TEXTURE_2D_MULTISAMPLE, - /** @deprecated Use @ref Magnum::MultisampleTexture2DArray "MultisampleTexture2DArray" class instead. */ + /** @deprecated Use @ref MultisampleTexture2DArray class instead. */ Texture2DMultisampleArray = GL_TEXTURE_2D_MULTISAMPLE_ARRAY, - /** @deprecated Use @ref Magnum::RectangleTexture "RectangleTexture" class instead. */ + /** @deprecated Use @ref RectangleTexture class instead. */ Rectangle = GL_TEXTURE_RECTANGLE }; #else @@ -170,20 +170,15 @@ template class Texture: public AbstractTexture { #ifdef MAGNUM_BUILD_DEPRECATED /** @copybrief Texture() - * @deprecated Use the parameterless @ref Magnum::Texture::Texture() "Texture()" - * constructor or dedicated @ref Magnum::TextureArray "TextureArray", - * @ref Magnum::MultisampleTexture "MultisampleTexture", - * @ref Magnum::RectangleTexture "RectangleTexture" classes - * instead. + * @deprecated Use the parameterless @ref Texture() "Texture()" + * constructor or dedicated @ref TextureArray, + * @ref MultisampleTexture, @ref RectangleTexture classes instead. */ explicit CORRADE_DEPRECATED("use the parameterless constructor or dedicated TextureArray, MultisampleTexture, RectangleTexture classes instead") Texture(Target target): AbstractTexture(GLenum(target)) {} /** @brief Texture target - * @deprecated Use dedicated @ref Magnum::Texture "Texture", - * @ref Magnum::TextureArray "TextureArray", - * @ref Magnum::MultisampleTexture "MultisampleTexture", - * @ref Magnum::RectangleTexture "RectangleTexture" classes - * instead. + * @deprecated Use dedicated @ref Texture, @ref TextureArray, + * @ref MultisampleTexture, @ref RectangleTexture classes instead. */ constexpr CORRADE_DEPRECATED("use dedicated Texture, TextureArray, MultisampleTexture, RectangleTexture classes instead") Target target() const { return static_cast(_target); } #endif @@ -757,8 +752,7 @@ template class Texture: public AbstractTexture { * needs to be bound to some texture unit before the operation. * @see @ref maxSize(), @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and * @fn_gl{TexImage1D} / @fn_gl{TexImage2D} / @fn_gl{TexImage3D} - * @deprecated_gl Prefer to use @ref Magnum::Texture::setStorage() "setStorage()" - * and @ref Magnum::Texture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ Texture& setImage(Int level, TextureFormat internalFormat, const ImageReference& image) { @@ -770,8 +764,7 @@ template class Texture: public AbstractTexture { /** @overload * @requires_gles30 Pixel buffer objects are not available in OpenGL ES * 2.0. - * @deprecated_gl Prefer to use @ref Magnum::Texture::setStorage() "setStorage()" - * and @ref Magnum::Texture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ Texture& setImage(Int level, TextureFormat internalFormat, BufferImage& image) { @@ -782,8 +775,7 @@ template class Texture: public AbstractTexture { /** @overload * @requires_gles30 Pixel buffer objects are not available in OpenGL ES * 2.0. - * @deprecated_gl Prefer to use @ref Magnum::Texture::setStorage() "setStorage()" - * and @ref Magnum::Texture::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ Texture& setImage(Int level, TextureFormat internalFormat, BufferImage&& image) { diff --git a/src/Magnum/TextureArray.h b/src/Magnum/TextureArray.h index 3f4af188b..d50a344ac 100644 --- a/src/Magnum/TextureArray.h +++ b/src/Magnum/TextureArray.h @@ -440,8 +440,7 @@ template class TextureArray: public AbstractTexture { * * See @ref Texture::setImage() for more information. * @see @ref maxSize() - * @deprecated_gl Prefer to use @ref Magnum::TextureArray::setStorage() "setStorage()" - * and @ref Magnum::TextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ TextureArray& setImage(Int level, TextureFormat internalFormat, const ImageReference& image) { @@ -450,8 +449,7 @@ template class TextureArray: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::TextureArray::setStorage() "setStorage()" - * and @ref Magnum::TextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ TextureArray& setImage(Int level, TextureFormat internalFormat, BufferImage& image) { @@ -460,8 +458,7 @@ template class TextureArray: public AbstractTexture { } /** @overload - * @deprecated_gl Prefer to use @ref Magnum::TextureArray::setStorage() "setStorage()" - * and @ref Magnum::TextureArray::setSubImage() "setSubImage()" + * @deprecated_gl Prefer to use @ref setStorage() and @ref setSubImage() * instead. */ TextureArray& setImage(Int level, TextureFormat internalFormat, BufferImage&& image) { @@ -550,8 +547,7 @@ template class TextureArray: public AbstractTexture { @brief One-dimensional texture array @requires_gl30 Extension @extension{EXT,texture_array} -@requires_gl Only @ref Magnum::Texture2DArray "Texture2DArray" is available in - OpenGL ES. +@requires_gl Only @ref Texture2DArray is available in OpenGL ES. */ typedef TextureArray<1> Texture1DArray; #endif diff --git a/src/Magnum/TextureFormat.h b/src/Magnum/TextureFormat.h index 821a7911b..08b0f35a4 100644 --- a/src/Magnum/TextureFormat.h +++ b/src/Magnum/TextureFormat.h @@ -55,7 +55,7 @@ enum class TextureFormat: GLenum { * @requires_gles30 Extension @es_extension{EXT,texture_rg} in OpenGL ES * 2.0 * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::TextureFormat::R8 "TextureFormat::R8". + * format, e.g. @ref TextureFormat::R8. */ #ifndef MAGNUM_TARGET_GLES2 Red = GL_RED, @@ -68,8 +68,8 @@ enum class TextureFormat: GLenum { * @requires_gl30 Extension @extension{ARB,texture_rg} * @requires_gles30 Extension @es_extension{EXT,texture_rg} and * @es_extension{EXT,texture_storage} in OpenGL ES 2.0. For texture - * storage only, for image specification use - * @ref Magnum::TextureFormat::Red "TextureFormat::Red" instead. + * storage only, for image specification use @ref TextureFormat::Red + * instead. */ #ifndef MAGNUM_TARGET_GLES2 R8 = GL_R8, @@ -86,7 +86,7 @@ enum class TextureFormat: GLenum { * @requires_gles30 Extension @es_extension{EXT,texture_rg} in OpenGL ES * 2.0 * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::TextureFormat::RG8 "TextureFormat::RG8". + * format, e.g. @ref TextureFormat::RG8. */ #ifndef MAGNUM_TARGET_GLES2 RG = GL_RG, @@ -99,8 +99,8 @@ enum class TextureFormat: GLenum { * @requires_gl30 Extension @extension{ARB,texture_rg} * @requires_gles30 Extension @es_extension{EXT,texture_rg} and * @es_extension{EXT,texture_storage} in OpenGL ES 2.0. For texture - * storage only, for image specification use - * @ref Magnum::TextureFormat::RG "TextureFormat::RG" instead. + * storage only, for image specification use @ref TextureFormat::RG + * instead. */ #ifndef MAGNUM_TARGET_GLES2 RG8 = GL_RG8, @@ -113,7 +113,7 @@ enum class TextureFormat: GLenum { * unemulated @ref Texture::setStorage() "*Texture::setStorage()" calls, in * that case use @ref TextureFormat::RGB8 "TextureFormat::RGB8" instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::TextureFormat::RGB8 "TextureFormat::RGB8". + * format, e.g. @ref TextureFormat::RGB8. */ RGB = GL_RGB, @@ -134,7 +134,7 @@ enum class TextureFormat: GLenum { * unemulated @ref Texture::setStorage() "*Texture::setStorage()" calls, in * that case use @ref TextureFormat::RGBA8 "TextureFormat::RGBA8" instead. * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::TextureFormat::RGBA8 "TextureFormat::RGBA8". + * format, e.g. @ref TextureFormat::RGBA8. */ RGBA = GL_RGBA, @@ -508,9 +508,9 @@ enum class TextureFormat: GLenum { * Size implementation-dependent. Not allowed in unemulated * @ref Texture::setStorage() "*Texture::setStorage()" calls. * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::TextureFormat::R8 "TextureFormat::R8" instead. + * @ref TextureFormat::R8 instead. * @deprecated_gl Included for compatibility reasons only, use - * @ref Magnum::TextureFormat::R8 "TextureFormat::R8" instead. + * @ref TextureFormat::R8 instead. */ Luminance = GL_LUMINANCE, @@ -520,9 +520,9 @@ enum class TextureFormat: GLenum { * implementation-dependent. Not allowed in unemulated * @ref Texture::setStorage() "*Texture::setStorage()" calls. * @requires_gles20 Not available in ES 3.0 or desktop OpenGL. Use - * @ref Magnum::TextureFormat::RG8 "TextureFormat::RG8" instead. + * @ref TextureFormat::RG8 instead. * @deprecated_gl Included for compatibility reasons only, use - * @ref Magnum::TextureFormat::RG8 "TextureFormat::RG8" instead. + * @ref TextureFormat::RG8 instead. */ LuminanceAlpha = GL_LUMINANCE_ALPHA, #endif @@ -542,9 +542,8 @@ enum class TextureFormat: GLenum { /** * RGB, each component normalized unsigned 5bit. - * @requires_gl Use @ref Magnum::TextureFormat::RGB5A1 "TextureFormat::RGB5A1" - * or @ref Magnum::TextureFormat::RGB565 "TextureFormat::RGB565" in - * OpenGL ES. + * @requires_gl Use @ref TextureFormat::RGB5A1 or @ref TextureFormat::RGB565 + * in OpenGL ES. */ RGB5 = GL_RGB5, #endif @@ -564,8 +563,7 @@ enum class TextureFormat: GLenum { * and either @es_extension{OES,required_internalformat} (for image * specification) or @es_extension{EXT,texture_storage} (for texture * storage) in OpenGL ES 2.0. Included for compatibility reasons only, - * use @ref Magnum::TextureFormat::RGB10A2 "TextureFormat::RGB10A2" in - * OpenGL ES 3.0 instead. + * use @ref TextureFormat::RGB10A2 in OpenGL ES 3.0 instead. */ #ifndef MAGNUM_TARGET_GLES RGB10 = GL_RGB10, @@ -594,8 +592,7 @@ enum class TextureFormat: GLenum { /** * RGB, unsigned with exponent, each RGB component 9bit, exponent 5bit. * @requires_gl30 Extension @extension{EXT,texture_shared_exponent} - * @requires_gles30 Use @ref Magnum::TextureFormat::RGB "TextureFormat::RGB" - * in OpenGL ES 2.0 instead. + * @requires_gles30 Use @ref TextureFormat::RGB in OpenGL ES 2.0 instead. */ RGB9E5 = GL_RGB9_E5, #endif @@ -606,7 +603,7 @@ enum class TextureFormat: GLenum { * that case use @ref TextureFormat::SRGB8 "TextureFormat::SRGB8" instead. * @requires_es_extension Extension @es_extension{EXT,sRGB} * @deprecated_gl Prefer to use the exactly specified version of this - * format, i.e. @ref Magnum::TextureFormat::SRGB8 "TextureFormat::SRGB8". + * format, i.e. @ref TextureFormat::SRGB8. * @todo is this allowed in core? */ #ifndef MAGNUM_TARGET_GLES @@ -618,8 +615,7 @@ enum class TextureFormat: GLenum { #ifndef MAGNUM_TARGET_GLES2 /** * sRGB, each component normalized unsigned byte. - * @requires_gles30 Use @ref Magnum::TextureFormat::SRGB "TextureFormat::SRGB" - * in OpenGL ES 2.0 instead. + * @requires_gles30 Use @ref TextureFormat::SRGB in OpenGL ES 2.0 instead. */ SRGB8 = GL_SRGB8, #endif @@ -685,7 +681,7 @@ enum class TextureFormat: GLenum { * that case use @ref TextureFormat::SRGB8Alpha8 "TextureFormat::SRGB8Alpha8" instead. * @requires_es_extension Extension @es_extension{EXT,sRGB} * @deprecated_gl Prefer to use the exactly specified version of this - * format, i.e. @ref Magnum::TextureFormat::SRGB8Alpha8 "TextureFormat::SRGB8Alpha8". + * format, i.e. @ref TextureFormat::SRGB8Alpha8. * @todo is this allowed in core? */ #ifndef MAGNUM_TARGET_GLES @@ -697,8 +693,8 @@ enum class TextureFormat: GLenum { #ifndef MAGNUM_TARGET_GLES2 /** * sRGBA, each component normalized unsigned byte. - * @requires_gles30 Use @ref Magnum::TextureFormat::SRGBAlpha "TextureFormat::SRGBAlpha" - * in OpenGL ES 2.0 instead. + * @requires_gles30 Use @ref TextureFormat::SRGBAlpha in OpenGL ES 2.0 + * instead. */ SRGB8Alpha8 = GL_SRGB8_ALPHA8, #endif @@ -807,7 +803,7 @@ enum class TextureFormat: GLenum { * @requires_gles30 Extension @es_extension{OES,depth_texture} or * @es_extension{ANGLE,depth_texture} in OpenGL ES 2.0 * @deprecated_gl Prefer to use the exactly specified version of this - * format, e.g. @ref Magnum::TextureFormat::DepthComponent24 "TextureFormat::DepthComponent24". + * format, e.g. @ref TextureFormat::DepthComponent24. */ DepthComponent = GL_DEPTH_COMPONENT, @@ -876,7 +872,7 @@ enum class TextureFormat: GLenum { * @requires_gles30 Extension @es_extension{OES,packed_depth_stencil} or * @es_extension{ANGLE,depth_texture} in OpenGL ES 2.0 * @deprecated_gl Prefer to use exactly specified version of this format, - * e.g. @ref Magnum::TextureFormat::Depth24Stencil8 "TextureFormat::Depth24Stencil8". + * e.g. @ref TextureFormat::Depth24Stencil8. */ #ifndef MAGNUM_TARGET_GLES2 DepthStencil = GL_DEPTH_STENCIL, diff --git a/src/Magnum/TimeQuery.h b/src/Magnum/TimeQuery.h index 65e68428f..e38a3761b 100644 --- a/src/Magnum/TimeQuery.h +++ b/src/Magnum/TimeQuery.h @@ -95,8 +95,7 @@ class TimeQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief TimeQuery(Target) - * @deprecated Use @ref Magnum::TimeQuery::TimeQuery(Target) "TimeQuery(Target)" - * instead. + * @deprecated Use @ref TimeQuery(Target) instead. */ CORRADE_DEPRECATED("use TimeQuery(Target) instead") explicit TimeQuery() {} #endif @@ -129,8 +128,7 @@ class TimeQuery: public AbstractQuery { #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief AbstractQuery::begin() - * @deprecated Use @ref Magnum::AbstractQuery::begin() "begin()" - * instead. + * @deprecated Use @ref AbstractQuery::begin() instead. */ CORRADE_DEPRECATED("use begin() instead") void begin(Target target) { AbstractQuery::begin(GLenum(target)); diff --git a/src/Magnum/TransformFeedback.h b/src/Magnum/TransformFeedback.h index 7566be996..cb41b6d8a 100644 --- a/src/Magnum/TransformFeedback.h +++ b/src/Magnum/TransformFeedback.h @@ -140,8 +140,7 @@ class MAGNUM_EXPORT TransformFeedback: public AbstractObject { * (part of OpenGL 4.0) is not available, returns the same value as * @ref maxSeparateAttributes(). * @see @fn_gl{Get} with @def_gl{MAX_TRANSFORM_FEEDBACK_BUFFERS} - * @requires_gl Use @ref Magnum::TransformFeedback::maxSeparateAttributes() "maxSeparateAttributes()" - * in OpenGL ES. + * @requires_gl Use @ref maxSeparateAttributes() in OpenGL ES. */ static Int maxBuffers(); #endif