Browse Source

doc: properly link to std::move().

Otherwise it does something crazy like linking to Utility::move()
instead, or linking to the thing from <algorithm>.
pull/168/head
Vladimír Vondruš 3 years ago
parent
commit
13c945064b
  1. 6
      doc/developers.dox
  2. 7
      doc/vulkan-wrapping.dox
  3. 7
      src/Magnum/Vk/Mesh.h

6
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

7
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

7
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

Loading…
Cancel
Save