From 239982901beaf039c25b264a9c6b63aa6fe70710 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Sat, 1 Aug 2020 00:33:49 +0200 Subject: Doc: Fix documentation warnings for Qt GUI * Drop deprecation warnings for now-dropped items * Use the 'qt6' define and a new \nothing doc macro to conditionally document items on Qt 6 * Add a custom module header for docs that pulls in also Vulkan headers * Add \internal command for internal classes/functions * Move QtGUI-related code snippets from widgets to gui docs Change-Id: Ieb386b96631a49568d09059906d307c45c01d93a Reviewed-by: Paul Wicking --- src/gui/vulkan/qvulkanwindow.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src/gui/vulkan/qvulkanwindow.cpp') diff --git a/src/gui/vulkan/qvulkanwindow.cpp b/src/gui/vulkan/qvulkanwindow.cpp index 36d8ecef89..8f6d32b89e 100644 --- a/src/gui/vulkan/qvulkanwindow.cpp +++ b/src/gui/vulkan/qvulkanwindow.cpp @@ -1579,8 +1579,8 @@ bool QVulkanWindow::event(QEvent *e) /*! \typedef QVulkanWindow::QueueCreateInfoModifier - A function function that is called during graphics initialization to add - additAional queues that should be created. + A function that is called during graphics initialization to add + additional queues that should be created. Set if the renderer needs additional queues besides the default graphics queue (e.g. a transfer queue). @@ -1588,17 +1588,17 @@ bool QVulkanWindow::event(QEvent *e) the additional queues. The renderer can subsequently request the actual queue in initResources(). - Note when requesting additional graphics queues: Qt itself always requests - a graphics queue, you'll need to search queueCreateInfo for the appropriate + \note When requesting additional graphics queues, Qt itself always requests + a graphics queue. You'll need to search queueCreateInfo for the appropriate entry and manipulate it to obtain the additional queue. \sa setQueueCreateInfoModifier() */ /*! - Set a queue create info modification function. + Sets the queue create info modification function \a modifier. - \sa queueCreateInfoModifier() + \sa QueueCreateInfoModifier \since 5.15 */ @@ -1746,7 +1746,7 @@ void QVulkanWindowRenderer::releaseResources() } /*! - \fn QVulkanWindowRenderer::startNextFrame() + \fn void QVulkanWindowRenderer::startNextFrame() This virtual function is called when the draw calls for the next frame are to be added to the command buffer. -- cgit v1.2.3