rhi docs: Correct inmodule and inheaderfile for all types

For QRhi this has been done not so long ago, but it seems the individual
classes, for example, QRhiTexture suffer from the same: the genereated
docs list the forwarding header, that does not exist.

Fixes: QTBUG-128548
Change-Id: I6a58caf45fa9bbfdb5b91311d7484c0954ad63e1
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
(cherry picked from commit 35791751a21f709d00726fb495bebc707f90a166)
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
This commit is contained in:
Laszlo Agocs 2024-09-02 12:29:33 +02:00
parent 80012d4df3
commit 30981cf522
7 changed files with 118 additions and 59 deletions

View File

@ -1148,7 +1148,8 @@ Q_LOGGING_CATEGORY(QRHI_LOG_RUB, "qt.rhi.rub")
/*!
\class QRhiInitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Base class for backend-specific initialization parameters.
@ -1160,7 +1161,8 @@ Q_LOGGING_CATEGORY(QRHI_LOG_RUB, "qt.rhi.rub")
/*!
\class QRhiDepthStencilClearValue
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Specifies clear values for a depth or stencil buffer.
@ -1239,7 +1241,8 @@ QDebug operator<<(QDebug dbg, const QRhiDepthStencilClearValue &v)
/*!
\class QRhiViewport
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Specifies a viewport rectangle.
@ -1364,7 +1367,8 @@ QDebug operator<<(QDebug dbg, const QRhiViewport &v)
/*!
\class QRhiScissor
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Specifies a scissor rectangle.
@ -1455,7 +1459,8 @@ QDebug operator<<(QDebug dbg, const QRhiScissor &s)
/*!
\class QRhiVertexInputBinding
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes a vertex input binding.
@ -1605,7 +1610,8 @@ QDebug operator<<(QDebug dbg, const QRhiVertexInputBinding &b)
/*!
\class QRhiVertexInputAttribute
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes a single vertex input element.
@ -1957,7 +1963,8 @@ quint32 QRhiImplementation::byteSizePerVertexForVertexInputFormat(QRhiVertexInpu
/*!
\class QRhiVertexInputLayout
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the layout of vertex inputs consumed by a vertex shader.
@ -2085,7 +2092,8 @@ QDebug operator<<(QDebug dbg, const QRhiVertexInputLayout &v)
/*!
\class QRhiShaderStage
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Specifies the type and the shader code for a shader stage in the pipeline.
@ -2231,7 +2239,8 @@ QDebug operator<<(QDebug dbg, const QRhiShaderStage &s)
/*!
\class QRhiColorAttachment
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the a single color attachment of a render target.
@ -2483,7 +2492,8 @@ QRhiColorAttachment::QRhiColorAttachment(QRhiRenderBuffer *renderBuffer)
/*!
\class QRhiTextureRenderTargetDescription
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the color and depth or depth/stencil attachments of a render target.
@ -2742,7 +2752,8 @@ QRhiTextureRenderTargetDescription::QRhiTextureRenderTargetDescription(const QRh
/*!
\class QRhiTextureSubresourceUploadDescription
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the source for one mip level in a layer in a texture upload operation.
@ -2951,7 +2962,8 @@ QRhiTextureSubresourceUploadDescription::QRhiTextureSubresourceUploadDescription
/*!
\class QRhiTextureUploadEntry
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes one layer (face for cubemaps, slice for 3D textures,
@ -3015,7 +3027,8 @@ QRhiTextureUploadEntry::QRhiTextureUploadEntry(int layer, int level,
/*!
\class QRhiTextureUploadDescription
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes a texture upload operation.
@ -3164,7 +3177,8 @@ QRhiTextureUploadDescription::QRhiTextureUploadDescription(std::initializer_list
/*!
\class QRhiTextureCopyDescription
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes a texture-to-texture copy operation.
@ -3272,7 +3286,8 @@ QRhiTextureUploadDescription::QRhiTextureUploadDescription(std::initializer_list
/*!
\class QRhiReadbackDescription
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes a readback (reading back texture contents from possibly GPU-only memory) operation.
@ -3375,7 +3390,8 @@ QRhiReadbackDescription::QRhiReadbackDescription(QRhiTexture *texture)
/*!
\class QRhiReadbackResult
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the results of a potentially asynchronous buffer or texture readback operation.
@ -3417,7 +3433,8 @@ QRhiReadbackDescription::QRhiReadbackDescription(QRhiTexture *texture)
/*!
\class QRhiNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Base class for classes exposing backend-specific collections of native resource objects.
@ -3427,7 +3444,8 @@ QRhiReadbackDescription::QRhiReadbackDescription(QRhiTexture *texture)
/*!
\class QRhiResource
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Base class for classes encapsulating native resource objects.
@ -3608,7 +3626,8 @@ QRhi *QRhiResource::rhi() const
/*!
\class QRhiBuffer
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Vertex, index, or uniform (constant) buffer resource.
@ -3788,7 +3807,8 @@ QRhi *QRhiResource::rhi() const
/*!
\class QRhiBuffer::NativeBuffer
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Contains information about the underlying native resources of a buffer.
*/
@ -3996,7 +4016,8 @@ void QRhiBuffer::fullDynamicBufferUpdateForCurrentFrame(const void *data)
/*!
\class QRhiRenderBuffer
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Renderbuffer resource.
@ -4036,7 +4057,8 @@ void QRhiBuffer::fullDynamicBufferUpdateForCurrentFrame(const void *data)
/*!
\struct QRhiRenderBuffer::NativeRenderBuffer
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Wraps a native renderbuffer object.
*/
@ -4183,7 +4205,8 @@ bool QRhiRenderBuffer::createFrom(NativeRenderBuffer src)
/*!
\class QRhiTexture
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Texture resource.
@ -4405,7 +4428,8 @@ bool QRhiRenderBuffer::createFrom(NativeRenderBuffer src)
/*!
\struct QRhiTexture::NativeTexture
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Contains information about the underlying native resources of a texture.
*/
@ -4635,7 +4659,8 @@ void QRhiTexture::setNativeLayout(int layout)
/*!
\struct QRhiTexture::ViewFormat
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.8
\brief Specifies the view format for reading or writing from or to the texture.
@ -4716,7 +4741,8 @@ void QRhiTexture::setNativeLayout(int layout)
/*!
\class QRhiSampler
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Sampler resource.
@ -4853,7 +4879,8 @@ QRhiResource::Type QRhiSampler::resourceType() const
/*!
\class QRhiRenderPassDescriptor
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Render pass resource.
@ -4969,7 +4996,8 @@ const QRhiNativeHandles *QRhiRenderPassDescriptor::nativeHandles()
/*!
\class QRhiRenderTarget
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Represents an onscreen (swapchain) or offscreen (texture) render target.
@ -5051,7 +5079,8 @@ QRhiSwapChainRenderTarget::QRhiSwapChainRenderTarget(QRhiImplementation *rhi, QR
/*!
\class QRhiSwapChainRenderTarget
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Swapchain render target resource.
@ -5081,7 +5110,8 @@ QRhiResource::Type QRhiSwapChainRenderTarget::resourceType() const
/*!
\class QRhiTextureRenderTarget
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Texture render target resource.
@ -5247,7 +5277,8 @@ QRhiResource::Type QRhiTextureRenderTarget::resourceType() const
/*!
\class QRhiShaderResourceBindings
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Encapsulates resources for making buffer, texture, sampler resources visible to shaders.
@ -5440,7 +5471,8 @@ void QRhiImplementation::updateLayoutDesc(QRhiShaderResourceBindings *srb)
/*!
\class QRhiShaderResourceBinding
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the shader resource for a single binding point.
@ -6380,7 +6412,8 @@ QDebug operator<<(QDebug dbg, const QRhiShaderResourceBindings &srb)
/*!
\class QRhiGraphicsPipeline
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Graphics pipeline state resource.
@ -6632,7 +6665,8 @@ QDebug operator<<(QDebug dbg, const QRhiShaderResourceBindings &srb)
/*!
\struct QRhiGraphicsPipeline::TargetBlend
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the blend state for one color attachment.
@ -6680,7 +6714,8 @@ QDebug operator<<(QDebug dbg, const QRhiShaderResourceBindings &srb)
/*!
\struct QRhiGraphicsPipeline::StencilOpState
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the stencil operation state.
@ -7096,7 +7131,8 @@ QRhiResource::Type QRhiGraphicsPipeline::resourceType() const
/*!
\class QRhiSwapChain
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Swapchain resource.
@ -7608,7 +7644,8 @@ QRhiRenderTarget *QRhiSwapChain::currentFrameRenderTarget(StereoTargetBuffer tar
/*!
\struct QRhiSwapChainHdrInfo
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the high dynamic range related information of the
@ -7849,7 +7886,8 @@ QDebug operator<<(QDebug dbg, const QRhiSwapChainHdrInfo &info)
/*!
\class QRhiComputePipeline
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Compute pipeline state resource.
@ -7932,7 +7970,8 @@ QRhiComputePipeline::QRhiComputePipeline(QRhiImplementation *rhi)
/*!
\class QRhiCommandBuffer
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Command buffer resource.
@ -8616,7 +8655,8 @@ bool QRhi::probe(QRhi::Implementation impl, QRhiInitParams *params)
/*!
\struct QRhiSwapChainProxyData
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Opaque data describing native objects needed to set up a swapchain.
@ -8722,7 +8762,8 @@ const char *QRhi::backendName() const
/*!
\struct QRhiDriverInfo
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Describes the physical device, adapter, or graphics API
@ -8880,7 +8921,8 @@ void QRhi::runCleanup()
/*!
\class QRhiResourceUpdateBatch
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Records upload and copy type of operations.
@ -10376,7 +10418,8 @@ void QRhi::setPipelineCacheData(const QByteArray &data)
/*!
\struct QRhiStats
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Statistics provided from the underlying memory allocator.

View File

@ -28,7 +28,8 @@ using namespace Qt::StringLiterals;
/*!
\class QRhiD3D11InitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Direct3D 11 specific initialization parameters.
@ -81,7 +82,8 @@ using namespace Qt::StringLiterals;
/*!
\class QRhiD3D11NativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the D3D device and device context used by the QRhi.

View File

@ -23,7 +23,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiD3D12InitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Direct3D 12 specific initialization parameters.
\note This is a RHI API with limited compatibility guarantees, see \l QRhi
@ -70,7 +71,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiD3D12NativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Holds the D3D12 device used by the QRhi.
\note The class uses \c{void *} as the type since including the COM-based
@ -129,7 +131,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiD3D12CommandBufferNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\brief Holds the ID3D12GraphicsCommandList1 object that is backing a QRhiCommandBuffer.
\note The command list object is only guaranteed to be valid, and

View File

@ -28,7 +28,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiGles2InitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief OpenGL specific initialization parameters.
@ -140,7 +141,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiGles2NativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the OpenGL context used by the QRhi.

View File

@ -57,7 +57,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiMetalInitParams
\inmodule QtRhi
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Metal specific initialization parameters.
@ -95,7 +96,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiMetalNativeHandles
\inmodule QtRhi
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the Metal device used by the QRhi.
@ -118,7 +120,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiMetalCommandBufferNativeHandles
\inmodule QtRhi
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the MTLCommandBuffer and MTLRenderCommandEncoder objects that are backing a QRhiCommandBuffer.

View File

@ -9,7 +9,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiNullInitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Null backend specific initialization parameters.
@ -31,7 +32,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiNullNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Empty.

View File

@ -59,7 +59,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiVulkanInitParams
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Vulkan specific initialization parameters.
@ -189,7 +190,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiVulkanNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Collects device, queue, and other Vulkan objects that are used by the QRhi.
@ -247,7 +249,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiVulkanCommandBufferNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the Vulkan command buffer object that is backing a QRhiCommandBuffer.
@ -269,7 +272,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QRhiVulkanRenderPassNativeHandles
\inmodule QtGui
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\since 6.6
\brief Holds the Vulkan render pass object backing a QRhiRenderPassDescriptor.