From 4b7b74715d34262fcec28e92ec8b53744dbfba62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 5 Dec 2020 22:57:09 +0100 Subject: [PATCH] doc: forgot to list this Vulkan API. ... and Doxygen is shitty once again, totally ignoring the doc block on a forward declaration. FFS. --- doc/vulkan-mapping.dox | 2 +- src/Magnum/Vk/Memory.h | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/vulkan-mapping.dox b/doc/vulkan-mapping.dox index e8b8d53b2..19c91e7d5 100644 --- a/doc/vulkan-mapping.dox +++ b/doc/vulkan-mapping.dox @@ -231,7 +231,7 @@ Vulkan function | Matching API Vulkan function | Matching API --------------------------------------- | ------------ -@fn_vk{MapMemory}, \n @fn_vk{UnmapMemory} | | +@fn_vk{MapMemory}, \n @fn_vk{UnmapMemory} | @ref Memory::map(), @ref MemoryMapDeleter @fn_vk{MergePipelineCaches} | | @subsection vulkan-mapping-functions-q Q diff --git a/src/Magnum/Vk/Memory.h b/src/Magnum/Vk/Memory.h index e8f2263a2..334a19bcc 100644 --- a/src/Magnum/Vk/Memory.h +++ b/src/Magnum/Vk/Memory.h @@ -39,13 +39,6 @@ namespace Magnum { namespace Vk { -/** @relates Memory -@brief Deleter for mapped memory -@m_since_latest - -Deleter for the array returned from @ref Memory::map(). Calls -@fn_vk_keyword{UnmapMemory}. -*/ class MemoryMapDeleter; /** @@ -453,8 +446,15 @@ class MAGNUM_VK_EXPORT Memory { UnsignedLong _size; }; -#ifndef DOXYGEN_GENERATING_OUTPUT +/** @relates Memory +@brief Deleter for mapped memory +@m_since_latest + +Deleter for the array returned from @ref Memory::map(). Calls +@fn_vk_keyword{UnmapMemory}. +*/ class MAGNUM_VK_EXPORT MemoryMapDeleter { + #ifndef DOXYGEN_GENERATING_OUTPUT public: explicit MemoryMapDeleter(): _unmap{}, _device{}, _memory{} {} explicit MemoryMapDeleter(void(*unmap)(VkDevice, VkDeviceMemory), VkDevice device, VkDeviceMemory memory): _unmap{unmap}, _device{device}, _memory{memory} {} @@ -466,8 +466,8 @@ class MAGNUM_VK_EXPORT MemoryMapDeleter { void(*_unmap)(VkDevice, VkDeviceMemory); VkDevice _device; VkDeviceMemory _memory; + #endif }; -#endif }}