summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Wicking <[email protected]>2024-02-14 13:55:38 +0100
committerPaul Wicking <[email protected]>2024-02-26 18:59:02 +0100
commit2fb8c2d5c331b1bc30a54e803e1cd17cf534fc32 (patch)
tree871e5e9f818ce4730bf30f7d4096be7603cd1445
parent8e0274c7a6ccd2beae6808019daffa5168744e3e (diff)
Doc: Use QDOC_PROPERTY for QRhiWidget::autoRenderTarget
`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. Pick-to: 6.7 Change-Id: Ia6255287f139ff23172c4fac96950e1a37eeef83 Reviewed-by: Topi Reiniƶ <[email protected]>
-rw-r--r--src/widgets/kernel/qrhiwidget.cpp6
-rw-r--r--src/widgets/kernel/qrhiwidget.h1
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 = {});