From a49bf6fc6a24b7f9035025fff67881c0ec04753b Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Wed, 14 Feb 2024 13:55:38 +0100 Subject: [PATCH] Doc: Use QDOC_PROPERTY for QRhiWidget::autoRenderTarget MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `autoRenderTarget` is a private bool that very much looks like it's used as a Q_PROPERTY. Use QDOC_PROPERTY for it to generate warning- free documentation. Change-Id: Ia6255287f139ff23172c4fac96950e1a37eeef83 Reviewed-by: Topi Reiniö (cherry picked from commit 2fb8c2d5c331b1bc30a54e803e1cd17cf534fc32) Reviewed-by: Qt Cherry-pick Bot --- src/widgets/kernel/qrhiwidget.cpp | 6 +++--- src/widgets/kernel/qrhiwidget.h | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/widgets/kernel/qrhiwidget.cpp b/src/widgets/kernel/qrhiwidget.cpp index aa08cb69143..ca2d6b51a9e 100644 --- a/src/widgets/kernel/qrhiwidget.cpp +++ b/src/widgets/kernel/qrhiwidget.cpp @@ -948,12 +948,12 @@ void QRhiWidget::setMirrorVertically(bool enabled) } /*! - \return the current setting for automatic depth-stencil buffer and render + \property QRhiWidget::autoRenderTarget + + The current setting for automatic depth-stencil buffer and render target maintenance. By default the value is \c true. - - \sa setAutoRenderTarget() */ bool QRhiWidget::isAutoRenderTargetEnabled() const { diff --git a/src/widgets/kernel/qrhiwidget.h b/src/widgets/kernel/qrhiwidget.h index 331ece3771b..45fe7b7482a 100644 --- a/src/widgets/kernel/qrhiwidget.h +++ b/src/widgets/kernel/qrhiwidget.h @@ -23,6 +23,7 @@ class Q_WIDGETS_EXPORT QRhiWidget : public QWidget Q_PROPERTY(TextureFormat colorBufferFormat READ colorBufferFormat WRITE setColorBufferFormat NOTIFY colorBufferFormatChanged) Q_PROPERTY(QSize fixedColorBufferSize READ fixedColorBufferSize WRITE setFixedColorBufferSize NOTIFY fixedColorBufferSizeChanged) Q_PROPERTY(bool mirrorVertically READ isMirrorVerticallyEnabled WRITE setMirrorVertically NOTIFY mirrorVerticallyChanged) + QDOC_PROPERTY(bool autoRenderTarget READ isAutoRenderTargetEnabled WRITE setAutoRenderTarget) public: explicit QRhiWidget(QWidget *parent = nullptr, Qt::WindowFlags f = {});