From 13c945064bd1c0fbf41492492685c13d291462f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 11 Sep 2023 12:14:16 +0200 Subject: [PATCH] doc: properly link to std::move(). Otherwise it does something crazy like linking to Utility::move() instead, or linking to the thing from . --- doc/developers.dox | 6 +++--- doc/vulkan-wrapping.dox | 7 ++++--- src/Magnum/Vk/Mesh.h | 7 ++++--- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/doc/developers.dox b/doc/developers.dox index 28a33d28a..39c87998c 100644 --- a/doc/developers.dox +++ b/doc/developers.dox @@ -966,9 +966,9 @@ unless it doesn't affect public API at all. @ref Vk::RenderPassCreateInfo), all its setters should have @cpp & @ce and @cpp && @ce overloads so it can be set up completely and passed to its destination in a single expression without any explicit - @cpp std::move() @ce. The overloads can be tested for correctness - rather easily, see `RenderPassTest::subpassDescriptionRvalue()` for an - example. + @m_class{m-doc-external} [std::move()](https://en.cppreference.com/w/cpp/utility/move). + The overloads can be tested for correctness rather easily, see + `RenderPassTest::subpassDescriptionRvalue()` for an example. @section developers-vk-extension-dependent Checklist for Vulkan extension-dependent code paths diff --git a/doc/vulkan-wrapping.dox b/doc/vulkan-wrapping.dox index b14af682e..14201a40b 100644 --- a/doc/vulkan-wrapping.dox +++ b/doc/vulkan-wrapping.dox @@ -182,9 +182,10 @@ is done implicitly: @snippet MagnumVk.cpp wrapping-optimizing-properties-device-single-expression However, if you instantiate @ref Vk::DeviceProperties and/or -@ref Vk::DeviceCreateInfo separately, you have to @cpp std::move() @ce them to -achieve the desired effect. An existing @ref Vk::ExtensionProperties instance -can be also passed to @ref Vk::DeviceCreateInfo to allow reuse: +@ref Vk::DeviceCreateInfo separately, you have to +@m_class{m-doc-external} [std::move()](https://en.cppreference.com/w/cpp/utility/move) +them to achieve the desired effect. An existing @ref Vk::ExtensionProperties +instance can be also passed to @ref Vk::DeviceCreateInfo to allow reuse: @snippet MagnumVk.cpp wrapping-optimizing-properties-device-move diff --git a/src/Magnum/Vk/Mesh.h b/src/Magnum/Vk/Mesh.h index 20c95964b..af66d0fc2 100644 --- a/src/Magnum/Vk/Mesh.h +++ b/src/Magnum/Vk/Mesh.h @@ -116,9 +116,10 @@ instead of vertices: To simplify resource management, it's possible to have the @ref Buffer instances owned by the @ref Mesh, as well as the @ref MeshLayout, either using -@ref std::move() or by directly passing a r-value. If a single buffer is used -for multiple bindings (for example as both a vertex and an index buffer), -perform the move last: +@m_class{m-doc-external} [std::move()](https://en.cppreference.com/w/cpp/utility/move) +or by directly passing a r-value. If a single buffer is used for multiple +bindings (for example as both a vertex and an index buffer), perform the move +last: @snippet MagnumVk.cpp Mesh-populating-owned