aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickrendercontrol.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-11-04 12:37:45 +0100
committerTopi Reinio <topi.reinio@qt.io>2020-11-05 09:00:48 +0100
commit0b12055548a8781b0c328991c267d62222667e8e (patch)
treede91b0183203dd00318fed9fa5ca4cff6713142a /src/quick/items/qquickrendercontrol.cpp
parentc01ad45d67ec0ce96d6944496dc292a94f17efea (diff)
Doc: Fix documentation warnings for Qt Quick
- Remove links to modules and examples that are not part of Qt 6. - Remove links to entities marked as \internal - Add missing enum value and QML property docs where it's trivial to do so. Task-number: QTBUG-88156 Change-Id: I10a1c7bcc5fe0e2354ea69eaf24930362edb7415 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/quick/items/qquickrendercontrol.cpp')
-rw-r--r--src/quick/items/qquickrendercontrol.cpp2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/quick/items/qquickrendercontrol.cpp b/src/quick/items/qquickrendercontrol.cpp
index 7d1ee373b2..c7a1ad973d 100644
--- a/src/quick/items/qquickrendercontrol.cpp
+++ b/src/quick/items/qquickrendercontrol.cpp
@@ -278,6 +278,8 @@ int QQuickRenderControl::samples() const
responsibility to create a suitable QVulkanInstance and
\l{QWindow::setVulkanInstance()}{associate it} with the QQuickWindow.
+ Returns \c true on success, \c false otherwise.
+
\note This function does not need to be, and must not be, called when using
the \c software adaptation of Qt Quick.