Browse Source

doc: fix references to Corrade string view literals.

Similar to previous commit, Doxygen 1.12 being finally strict and
refusing to link to this. There's a new (inline) namespace in between,
and it needs the Corrade:: prefix also.
pull/650/head
Vladimír Vondruš 2 years ago
parent
commit
1c3e384f06
  1. 2
      src/Magnum/Vk/DeviceCreateInfo.h
  2. 2
      src/Magnum/Vk/Instance.h
  3. 12
      src/Magnum/Vk/InstanceCreateInfo.h
  4. 4
      src/Magnum/Vk/ShaderSet.h

2
src/Magnum/Vk/DeviceCreateInfo.h

@ -187,7 +187,7 @@ class MAGNUM_VK_EXPORT DeviceCreateInfo {
* *
* @note The function makes copies of string views that are not global * @note The function makes copies of string views that are not global
* or null-terminated, use the * or null-terminated, use the
* @link Containers::Literals::operator""_s() @endlink * @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible. * literal to prevent that where possible.
*/ */
DeviceCreateInfo& addEnabledExtensions(const Containers::StringIterable& extensions) &; DeviceCreateInfo& addEnabledExtensions(const Containers::StringIterable& extensions) &;

2
src/Magnum/Vk/Instance.h

@ -82,7 +82,7 @@ required either, but may be beneficial for the driver:
@m_class{m-note m-success} @m_class{m-note m-success}
@par @par
The above code uses the @link Containers::Literals::operator""_s() @endlink The above code uses the @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
literal, which lets the library know that given string is global and literal, which lets the library know that given string is global and
null-terminated. Such strings then don't need to be copied internally to null-terminated. Such strings then don't need to be copied internally to
keep them in scope until they're consumed by Vulkan APIs. The same is keep them in scope until they're consumed by Vulkan APIs. The same is

12
src/Magnum/Vk/InstanceCreateInfo.h

@ -154,8 +154,8 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* *
* @note The function makes copies of string views that are not global * @note The function makes copies of string views that are not global
* or null-terminated, use the * or null-terminated, use the
* @link Containers::Literals::operator""_s() @endlink literal to * @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
* prevent that where possible. * literal to prevent that where possible.
*/ */
InstanceCreateInfo& setApplicationInfo(Containers::StringView name, Version version); InstanceCreateInfo& setApplicationInfo(Containers::StringView name, Version version);
@ -180,8 +180,8 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* *
* @note The function makes copies of string views that are not global * @note The function makes copies of string views that are not global
* or null-terminated, use the * or null-terminated, use the
* @link Containers::Literals::operator""_s() @endlink literal to * @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
* prevent that where possible. * literal to prevent that where possible.
*/ */
InstanceCreateInfo& addEnabledLayers(const Containers::StringIterable& layers); InstanceCreateInfo& addEnabledLayers(const Containers::StringIterable& layers);
@ -208,8 +208,8 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* *
* @note The function makes copies of string views that are not global * @note The function makes copies of string views that are not global
* or null-terminated, use the * or null-terminated, use the
* @link Containers::Literals::operator""_s() @endlink literal to * @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
* prevent that where possible. * literal to prevent that where possible.
*/ */
InstanceCreateInfo& addEnabledExtensions(const Containers::StringIterable& extensions); InstanceCreateInfo& addEnabledExtensions(const Containers::StringIterable& extensions);
/** @overload */ /** @overload */

4
src/Magnum/Vk/ShaderSet.h

@ -123,7 +123,7 @@ parameter is needed.
@m_class{m-note m-success} @m_class{m-note m-success}
@par @par
The above code uses the @link Containers::Literals::operator""_s() @endlink The above code uses the @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
literal, which lets the library know that given string is global and literal, which lets the library know that given string is global and
null-terminated. Such strings then don't need to be copied internally to null-terminated. Such strings then don't need to be copied internally to
keep them in scope until they're consumed by Vulkan APIs. keep them in scope until they're consumed by Vulkan APIs.
@ -185,7 +185,7 @@ class MAGNUM_VK_EXPORT ShaderSet {
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* The function makes a copy of @p entrypoint if it's not global or * The function makes a copy of @p entrypoint if it's not global or
* null-terminated, use the @link Containers::Literals::operator""_s() @endlink * null-terminated, use the @link Corrade::Containers::Literals::StringLiterals::operator""_s() Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible. * literal to prevent that where possible.
* *
* The populated @type_vk{VkPipelineShaderStageCreateInfo} is * The populated @type_vk{VkPipelineShaderStageCreateInfo} is

Loading…
Cancel
Save