Browse Source

Vk: Doxygen continues to be a massively underwhelming disappointment.

Nope, it's 2020 and there's still no way to link to &-qualified
functions. Feature that is in C++ since 2011.
pull/234/head
Vladimír Vondruš 6 years ago
parent
commit
7799a8d3ff
  1. 2
      doc/vulkan-mapping.dox
  2. 15
      src/Magnum/Vk/Device.h

2
doc/vulkan-mapping.dox

@ -320,7 +320,7 @@ Vulkan structure | Matching API
Vulkan structure | Matching API Vulkan structure | Matching API
--------------------------------------- | ------------ --------------------------------------- | ------------
@type_vk{DeviceCreateInfo} | @ref DeviceCreateInfo @type_vk{DeviceCreateInfo} | @ref DeviceCreateInfo
@type_vk{DeviceQueueCreateInfo} | not exposed, but you can pass a custom instance to @ref DeviceCreateInfo::addQueues(const VkDeviceQueueCreateInfo&) @type_vk{DeviceQueueCreateInfo} | not exposed, but you can pass a custom instance to @ref DeviceCreateInfo::addQueues()
@subsection vulkan-mapping-structures-i I @subsection vulkan-mapping-structures-i I

15
src/Magnum/Vk/Device.h

@ -207,8 +207,9 @@ class MAGNUM_VK_EXPORT DeviceCreateInfo {
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* At least one queue has to be added. * At least one queue has to be added.
* @see @ref DeviceProperties::pickQueueFamily(), * @see @ref DeviceProperties::pickQueueFamily()
* @ref addQueues(QueueFlags, Containers::ArrayView<const Float>, Containers::ArrayView<const Containers::Reference<Queue>>) * @todoc link to addQueues(QueueFlags) once doxygen finally GROWS UP
* and can link to &-qualified functions FFS
*/ */
DeviceCreateInfo& addQueues(UnsignedInt family, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &; DeviceCreateInfo& addQueues(UnsignedInt family, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &;
/** @overload */ /** @overload */
@ -223,13 +224,14 @@ class MAGNUM_VK_EXPORT DeviceCreateInfo {
* *
* Equivalent to picking a queue family first using * Equivalent to picking a queue family first using
* @ref DeviceProperties::pickQueueFamily() based on @p flags and then * @ref DeviceProperties::pickQueueFamily() based on @p flags and then
* calling @ref addQueues(UnsignedInt, Containers::ArrayView<const Float>, Containers::ArrayView<const Containers::Reference<Queue>>) * calling the above @ref addQueues() variant with the family index.
* with the family index.
* *
* Note that @ref DeviceProperties::pickQueueFamily() exits in case it * Note that @ref DeviceProperties::pickQueueFamily() exits in case it
* doesn't find any family satisfying given @p flags --- for a * doesn't find any family satisfying given @p flags --- for a
* failproof scenario you may want to go with the above overload and * failproof scenario you may want to go with the above overload and
* @ref DeviceProperties::tryPickQueueFamily() instead. * @ref DeviceProperties::tryPickQueueFamily() instead.
* @todoc link to addQueues(UnsignedInt) above once doxygen finally
* GROWS UP and can link to &-qualified functions FFS
*/ */
DeviceCreateInfo& addQueues(QueueFlags flags, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &; DeviceCreateInfo& addQueues(QueueFlags flags, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &;
/** @overload */ /** @overload */
@ -408,9 +410,12 @@ class MAGNUM_VK_EXPORT Device {
* @param info Device creation info * @param info Device creation info
* *
* After creating the device requests device queues added via * After creating the device requests device queues added via
* @ref DeviceCreateInfo::addQueues(UnsignedInt, Containers::ArrayView<const Float>, Containers::ArrayView<const Containers::Reference<Queue>>), populating the @ref Queue references. * @ref DeviceCreateInfo::addQueues(), populating the @ref Queue
* references.
* @see @fn_vk_keyword{CreateDevice}, @fn_vk_keyword{GetDeviceQueue2}, * @see @fn_vk_keyword{CreateDevice}, @fn_vk_keyword{GetDeviceQueue2},
* @fn_vk_keyword{GetDeviceQueue} * @fn_vk_keyword{GetDeviceQueue}
* @todoc link to a concrete addQueues() overload above once doxygen
* finally GROWS UP and can link to &-qualified functions FFS
*/ */
explicit Device(Instance& instance, const DeviceCreateInfo& info); explicit Device(Instance& instance, const DeviceCreateInfo& info);

Loading…
Cancel
Save