From 3bf08a825165bae244dbe7b961a2eff1935b6d21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 13 Nov 2022 17:11:01 +0100 Subject: [PATCH] Doc: don't link to long-deprecated APIs. --- doc/changelog.dox | 39 +++++++++++++---------------- doc/vulkan-support.dox | 4 +-- src/Magnum/Mesh.h | 8 +++--- src/Magnum/Trade/AbstractImporter.h | 14 +++++++---- src/Magnum/Trade/AnimationData.h | 12 ++++----- src/Magnum/Trade/ArrayAllocator.h | 10 ++++---- 6 files changed, 43 insertions(+), 44 deletions(-) diff --git a/doc/changelog.dox b/doc/changelog.dox index c4e623a9c..d6353e94e 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -648,11 +648,6 @@ See also: various types via a @cpp reinterpret_cast @ce. But in an effort to be UBSan-clean, this is no longer done. See also [mosra/magnum#531](https://github.com/mosra/magnum/issues/531). -@subsubsection changelog-latest-changes-vk Vk library - -- @ref Vk::hasVkSamplerAddressMode() and @ref Vk::vkSamplerAddressMode() now - recognizes @ref SamplerWrapping::MirrorClampToEdge - @subsection changelog-latest-buildsystem Build system - The oldest supported Clang version is now 6.0 (available on Ubuntu 18.04), @@ -1569,14 +1564,14 @@ Released 2020-06-27, tagged as - Updated Vulkan headers for version 1.2 - Conversion of @ref VertexFormat values to the @type_vk{Format} enum using - @ref Vk::vkFormat(Magnum::VertexFormat) + @cpp Vk::vkFormat(Magnum::VertexFormat) @ce @subsection changelog-2020-06-changes Changes and improvements - The @ref MeshPrimitive type can now store implementation-specific primitive types similarly to @ref PixelFormat and the new @ref VertexFormat. Implementation-specific types are then simply passed through in - @ref GL::meshPrimitive() and @ref Vk::vkPrimitiveTopology(). + @ref GL::meshPrimitive() and @cpp Vk::vkPrimitiveTopology() @ce. - The @ref PixelFormat and @ref CompressedPixelFormat enums can now be saved and retrieved from @ref Corrade::Utility::Configuration / @ref Corrade::Utility::Arguments @@ -2081,11 +2076,11 @@ Released 2019-10-24, tagged as - Added sRGB BC1-3, BC4, BC5, BC6h, BC7, ETC2, EAC, 2D/3D ASTC and PVRTC formats to @ref CompressedPixelFormat as well as their conversion to corresponding GL/Vulkan formats in @ref GL::compressedPixelFormat() and - @ref Vk::vkFormat(Magnum::CompressedPixelFormat) + @cpp Vk::vkFormat(Magnum::CompressedPixelFormat) @ce - New @ref PixelFormat::R8Srgb, @ref PixelFormat::RG8Srgb, @ref PixelFormat::RGB8Srgb and @ref PixelFormat::RGBA8Srgb sRGB pixel formats as well as their conversion to corresponding GL/Vulkan formats in - @ref GL::pixelFormat() and @ref Vk::vkFormat(Magnum::PixelFormat) + @ref GL::pixelFormat() and @cpp Vk::vkFormat(Magnum::PixelFormat) @ce - New @cpp compressedBlockSize() @ce and @cpp compressedBlockDataSize() @ce utilities for querying parameters of @ref CompressedPixelFormat entries, similar to what @cpp pixelSize() @ce is for @ref PixelFormat @@ -3291,16 +3286,16 @@ Released 2018-10-23, tagged as - @ref Trade::AnimationData class and animation import interface in @ref Trade::AbstractImporter::animation() and related functions -- New @ref Trade::AbstractMaterialData::flags(), - @ref Trade::AbstractMaterialData::alphaMode() and - @ref Trade::AbstractMaterialData::alphaMask() material properties +- New @cpp Trade::AbstractMaterialData::flags() @ce, + @cpp Trade::AbstractMaterialData::alphaMode() @ce and + @cpp Trade::AbstractMaterialData::alphaMask() @ce material properties - New @ref Trade::CameraData::type(), @ref Trade::CameraData::aspectRatio() and @ref Trade::CameraData::size() properties, ability to describe 2D cameras -- @ref Trade::ObjectData2D and @ref Trade::ObjectData3D now support also - separate translation / rotation / scaling specification instead of a - combined transformation matrix. See @ref Trade::ObjectData2D::transformation() - and @ref Trade::ObjectData3D::transformation() for more information. +- @cpp Trade::ObjectData2D @ce and @cpp Trade::ObjectData3D @ce now support + also separate translation / rotation / scaling specification instead of a + combined transformation matrix. See @cpp Trade::ObjectData2D::transformation() @ce + and @cpp Trade::ObjectData3D::transformation() @ce for more information. - Support for file loading callbacks in @ref Trade::AbstractImporter - Debug output for @cpp Trade::AbstractImporter::Feature @ce, @cpp Trade::AbstractImageConverter::Feature @ce enums and @@ -3318,12 +3313,12 @@ Released 2018-10-23, tagged as - New @ref Vk library that'll be the home of a Vulkan graphics backend in the future -- New functions @ref Vk::hasVkPrimitiveTopology(), - @ref Vk::vkPrimitiveTopology(), @ref Vk::hasVkIndexType(), - @ref Vk::vkIndexType(), @ref Vk::hasVkFormat(), @ref Vk::vkFormat(), - @ref Vk::vkFilter(), @ref Vk::vkSamplerMipmapMode(), - @ref Vk::hasVkSamplerAddressMode(), @ref Vk::vkSamplerAddressMode() for - converting generic @ref MeshPrimitive, @ref MeshIndexType, +- New functions @cpp Vk::hasVkPrimitiveTopology() @ce, + @cpp Vk::vkPrimitiveTopology() @ce, @cpp Vk::hasVkIndexType() @ce, + @cpp Vk::vkIndexType() @ce, @cpp Vk::hasVkFormat() @ce, @cpp Vk::vkFormat() @ce, + @cpp Vk::vkFilter() @ce, @cpp Vk::vkSamplerMipmapMode() @ce, + @cpp Vk::hasVkSamplerAddressMode() @ce, @cpp Vk::vkSamplerAddressMode() @ce + for converting generic @ref MeshPrimitive, @ref MeshIndexType, @ref PixelFormat, @ref CompressedPixelFormat, @ref SamplerFilter, @ref SamplerMipmap and @ref SamplerWrapping enums to Vulkan-specific values diff --git a/doc/vulkan-support.dox b/doc/vulkan-support.dox index 2410dc420..cfae4cc55 100644 --- a/doc/vulkan-support.dox +++ b/doc/vulkan-support.dox @@ -84,7 +84,7 @@ Extension | Status Extension | Status --------------------------------------------------- | ------ -@vk_extension{KHR,sampler_mirror_clamp_to_edge} | @ref Vk::vkSamplerAddressMode() only +@vk_extension{KHR,sampler_mirror_clamp_to_edge} | done @vk_extension{KHR,shader_float16_int8} | | @vk_extension{KHR,imageless_framebuffer} | | @vk_extension{KHR,create_renderpass2} | done @@ -121,7 +121,7 @@ Extension | Status @vk_extension{EXT,debug_utils} @m_class{m-label m-info} **instance** | | @vk_extension{EXT,validation_features} @m_class{m-label m-info} **instance** | | @vk_extension{EXT,vertex_attribute_divisor} | done -@vk_extension{EXT,index_type_uint8} | @ref Vk::vkIndexType() only +@vk_extension{EXT,index_type_uint8} | done @vk_extension{EXT,extended_dynamic_state} | only dynamic primitive and stride @vk_extension{EXT,robustness2} | done except properties @vk_extension{EXT,image_robustness} | done diff --git a/src/Magnum/Mesh.h b/src/Magnum/Mesh.h index 331754793..25e7b4c4e 100644 --- a/src/Magnum/Mesh.h +++ b/src/Magnum/Mesh.h @@ -48,10 +48,10 @@ In case of OpenGL, corresponds to @ref GL::MeshPrimitive and is convertible to it using @ref GL::meshPrimitive(). See documentation of each value for more information about the mapping. -In case of Vulkan, corresponds to @type_vk_keyword{PrimitiveTopology} and is -convertible to it using @ref Vk::vkPrimitiveTopology(). See documentation of -each value for more information about the mapping. Note that not every mode is available there, use @ref Vk::hasVkPrimitiveTopology() to check for its -presence. +In case of Vulkan, corresponds to @ref Vk::MeshPrimitive and is convertible to +it using @ref Vk::meshPrimitive(). See documentation of each value for more +information about the mapping. Note that not every mode is available there, use +@ref Vk::hasMeshPrimitive() to check for its presence. For D3D, corresponds to @m_class{m-doc-external} [D3D_PRIMITIVE_TOPOLOGY](https://docs.microsoft.com/en-us/windows/win32/api/d3dcommon/ne-d3dcommon-d3d_primitive_topology); for Metal, corresponds to @m_class{m-doc-external} [MTLPrimitiveType](https://developer.apple.com/documentation/metal/mtlprimitivetype?language=objc). diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index 86055909a..f32eda30f 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -1719,12 +1719,16 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi * documentation of a particular plugin for more information about * returned type and contents. Returns @cpp nullptr @ce by default. * Expects that a file is opened. - * @see @ref AbstractMaterialData::importerState(), - * @ref AnimationData::importerState(), @ref CameraData::importerState(), - * @ref ImageData::importerState(), @ref LightData::importerState(), + * @see @ref MaterialData::importerState(), + * @ref AnimationData::importerState(), + * @ref CameraData::importerState(), + * @ref ImageData::importerState(), + * @ref LightData::importerState(), * @ref MeshData::importerState(), - * @ref ObjectData2D::importerState(), @ref ObjectData3D::importerState(), - * @ref SceneData::importerState(), @ref TextureData::importerState() + * @ref SceneData::importerState(), + * @ref SkinData2D::importerState(), + * @ref SkinData3D::importerState(), + * @ref TextureData::importerState() */ const void* importerState() const; diff --git a/src/Magnum/Trade/AnimationData.h b/src/Magnum/Trade/AnimationData.h index 2de24976b..317a3fb3b 100644 --- a/src/Magnum/Trade/AnimationData.h +++ b/src/Magnum/Trade/AnimationData.h @@ -178,7 +178,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Vector2, * @ref AnimationTrackType::CubicHermite2D, - * @ref ObjectData2D::translation() + * @ref SceneField::Translation, @ref SceneData::is2D() */ Translation2D, @@ -190,7 +190,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Vector3, * @ref AnimationTrackType::CubicHermite3D, - * @ref ObjectData3D::translation() + * @ref SceneField::Translation, @ref SceneData::is3D() */ Translation3D, @@ -202,7 +202,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Complex, * @ref AnimationTrackType::CubicHermiteComplex, - * @ref ObjectData2D::rotation() + * @ref SceneField::Rotation. @ref SceneData::is2D() */ Rotation2D, @@ -214,7 +214,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Quaternion, * @ref AnimationTrackType::CubicHermiteQuaternion, - * @ref ObjectData3D::rotation() + * @ref SceneField::Rotation, @ref SceneData::is3D() */ Rotation3D, @@ -226,7 +226,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Vector2, * @ref AnimationTrackType::CubicHermite2D, - * @ref ObjectData2D::scaling() + * @ref SceneField::Scaling, @ref SceneData::is2D() */ Scaling2D, @@ -238,7 +238,7 @@ enum class AnimationTrackTargetType: UnsignedByte { * * @see @ref AnimationTrackType::Vector3, * @ref AnimationTrackType::CubicHermite3D, - * @ref ObjectData3D::scaling() + * @ref SceneField::Scaling, @ref SceneData::is3D() */ Scaling3D, diff --git a/src/Magnum/Trade/ArrayAllocator.h b/src/Magnum/Trade/ArrayAllocator.h index ff64015f4..585d6d52a 100644 --- a/src/Magnum/Trade/ArrayAllocator.h +++ b/src/Magnum/Trade/ArrayAllocator.h @@ -41,11 +41,11 @@ namespace Magnum { namespace Trade { @brief Growable array allocator to be used in importer plugins @m_since{2020,06} -Compared to @ref Corrade::Containers::ArrayMallocAllocator ensures that the -@ref Array deleter function pointer is defined in the @ref Trade library and -not in the plugin binary itself, avoiding dangling function pointer call when -the data array is destructed after the plugin has been unloaded. Other than -that the behavior is identical. +Compared to @relativeref{Corrade,Containers::ArrayMallocAllocator} ensures that +the @relativeref{Corrade,Containers::Array} deleter function pointer is defined +in the @ref Trade library and not in the plugin binary itself, avoiding +dangling function pointer call when the data array is destructed after the +plugin has been unloaded. Other than that the behavior is identical. */ template struct ArrayAllocator: Containers::ArrayMallocAllocator {};