From 13d7517c0edd4c99686f2a8f7611c51d0a56a279 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 8 Nov 2019 00:48:05 +0100 Subject: Doc: Fix documentation warnings There were a lot of documentation warnings introduced by the separation of QtQml.Models and QtQml.WorkerScript modules from the QtQml documentation project into their own sub-projects. Fix the above, and also ensure that the experimental Qt.labs.qmlmodels QML types are listed in the documentation, and add them also on the QML module page for QtQml.Models. A few warnings remain, they may be indicative of issues not in the scope of this commit. Fixes: QTBUG-79812 Change-Id: Idc25c976e4c96feab4aae893519d6c9245f57a64 Reviewed-by: Paul Wicking --- .../doc/src/metaltextureimport.qdoc | 2 +- src/imports/labsmodels/plugin.cpp | 2 +- src/imports/models/plugin.cpp | 17 ++++- src/particles/qquickparticleextruder.cpp | 2 +- src/qml/doc/images/listmodel-nested.png | Bin 7493 -> 0 bytes src/qml/doc/images/listmodel.png | Bin 3407 -> 0 bytes src/qml/doc/images/objectmodel.png | Bin 347 -> 0 bytes src/qml/doc/qtqml.qdocconf | 12 +--- src/qml/doc/snippets/qml/workerscript/script.mjs | 4 -- .../doc/snippets/qml/workerscript/workerscript.qml | 74 --------------------- src/qml/doc/src/qmlfunctions.qdoc | 1 + src/qml/qml/qqmlextensionplugin.cpp | 3 - src/qml/qml/qqmlinfo.cpp | 3 - src/qmlmodels/doc/images/listmodel-nested.png | Bin 0 -> 7493 bytes src/qmlmodels/doc/images/listmodel.png | Bin 0 -> 3407 bytes src/qmlmodels/doc/images/objectmodel.png | Bin 0 -> 347 bytes src/qmlmodels/doc/qtqmlmodels.qdocconf | 13 ++-- src/qmlmodels/qqmllistmodel.cpp | 4 +- src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf | 6 +- .../doc/snippets/qml/workerscript/script.mjs | 4 ++ .../doc/snippets/qml/workerscript/workerscript.qml | 74 +++++++++++++++++++++ src/quick/doc/qtquick.qdocconf | 5 +- src/quick/doc/snippets/cmake-macros/examples.cmake | 2 +- .../doc/src/concepts/visualcanvas/adaptations.qdoc | 2 +- src/quick/handlers/qquickwheelhandler.cpp | 16 +++-- src/quick/items/qquickitem.cpp | 4 +- src/quick/items/qquicklistview.cpp | 2 +- src/quick/items/qquickview.cpp | 9 ++- src/quick/items/qquickwindow.cpp | 2 +- .../scenegraph/coreapi/qsgmaterialrhishader.cpp | 2 +- src/quick/scenegraph/coreapi/qsgtexture.cpp | 4 +- src/quick/util/qquickpath.cpp | 8 +-- 32 files changed, 143 insertions(+), 134 deletions(-) delete mode 100644 src/qml/doc/images/listmodel-nested.png delete mode 100644 src/qml/doc/images/listmodel.png delete mode 100644 src/qml/doc/images/objectmodel.png delete mode 100644 src/qml/doc/snippets/qml/workerscript/script.mjs delete mode 100644 src/qml/doc/snippets/qml/workerscript/workerscript.qml create mode 100644 src/qmlmodels/doc/images/listmodel-nested.png create mode 100644 src/qmlmodels/doc/images/listmodel.png create mode 100644 src/qmlmodels/doc/images/objectmodel.png create mode 100644 src/qmlworkerscript/doc/snippets/qml/workerscript/script.mjs create mode 100644 src/qmlworkerscript/doc/snippets/qml/workerscript/workerscript.qml diff --git a/examples/quick/scenegraph/metaltextureimport/doc/src/metaltextureimport.qdoc b/examples/quick/scenegraph/metaltextureimport/doc/src/metaltextureimport.qdoc index 2a584c26cc..55cbcd8f2e 100644 --- a/examples/quick/scenegraph/metaltextureimport/doc/src/metaltextureimport.qdoc +++ b/examples/quick/scenegraph/metaltextureimport/doc/src/metaltextureimport.qdoc @@ -29,7 +29,7 @@ \example scenegraph/metaltextureimport \title Scene Graph - Metal Texture Import \ingroup qtquickexamples - \brief Shows how to use a texture created directly with Metal + \brief Shows how to use a texture created directly with Metal. \image metaltextureimport-example.jpg diff --git a/src/imports/labsmodels/plugin.cpp b/src/imports/labsmodels/plugin.cpp index cebc1dc920..697235e1ca 100644 --- a/src/imports/labsmodels/plugin.cpp +++ b/src/imports/labsmodels/plugin.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmlmodule Qt.labs.qmlmodels 1.0 \title Qt QML Models experimental QML Types \ingroup qmlmodules - \brief Provides QML experimental types for data models + \brief Provides QML experimental types for data models. \since 5.12 This QML module contains experimental QML types related to data models. diff --git a/src/imports/models/plugin.cpp b/src/imports/models/plugin.cpp index 9fe63412f3..319321013e 100644 --- a/src/imports/models/plugin.cpp +++ b/src/imports/models/plugin.cpp @@ -59,8 +59,23 @@ QT_BEGIN_NAMESPACE import QtQml.Models 2.\1 \endqml - Note that QtQml.Models module started at version 2.1 to match the version + \note QtQml.Models module started at version 2.1 to match the version of the parent module, \l{Qt QML}. + + In addition, Qt.labs.qmlmodels provides experimental QML types for models. + To use these experimental types, import the module with the following line: + + \qml + import Qt.labs.qmlmodels 1.0 + \endqml + + \section1 QML Types + \generatelist qmltypesbymodule QtQml.Models + + \section1 Experimental QML Types + \generatelist qmltypesbymodule Qt.labs.qmlmodels + + \noautolist */ diff --git a/src/particles/qquickparticleextruder.cpp b/src/particles/qquickparticleextruder.cpp index f56e288e09..ea64a79563 100644 --- a/src/particles/qquickparticleextruder.cpp +++ b/src/particles/qquickparticleextruder.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! - \qmltype Shape + \qmltype ParticleExtruder \instantiates QQuickParticleExtruder \inqmlmodule QtQuick.Particles \brief For specifying an area for affectors and emitters. diff --git a/src/qml/doc/images/listmodel-nested.png b/src/qml/doc/images/listmodel-nested.png deleted file mode 100644 index ee7ffba67a..0000000000 Binary files a/src/qml/doc/images/listmodel-nested.png and /dev/null differ diff --git a/src/qml/doc/images/listmodel.png b/src/qml/doc/images/listmodel.png deleted file mode 100644 index 7ab1771f15..0000000000 Binary files a/src/qml/doc/images/listmodel.png and /dev/null differ diff --git a/src/qml/doc/images/objectmodel.png b/src/qml/doc/images/objectmodel.png deleted file mode 100644 index 5e6d1325b2..0000000000 Binary files a/src/qml/doc/images/objectmodel.png and /dev/null differ diff --git a/src/qml/doc/qtqml.qdocconf b/src/qml/doc/qtqml.qdocconf index 74d0a3b27c..07ab974289 100644 --- a/src/qml/doc/qtqml.qdocconf +++ b/src/qml/doc/qtqml.qdocconf @@ -34,20 +34,14 @@ qhp.QtQml.subprojects.qmltypes.sortPages = true tagfile = ../../../doc/qtqml/qtqml.tags -depends += qtcore qtgui qtquick qtdoc qtlinguist qmake qtscript qtwidgets qtxmlpatterns qtquickcontrols +depends += qtcore qtqmlmodels qtqmlworkerscript qtgui qtquick qtdoc qtlinguist qmake qtscript qtwidgets qtxmlpatterns qtquickcontrols headerdirs += .. \ - ../../imports/models \ - ../../qmlmodels \ - ../../qml \ - ../../qmlworkerscript + ../../qml sourcedirs += .. \ - ../../imports/models \ ../../imports/statemachine \ - ../../qmlmodels \ - ../../qml \ - ../../qmlworkerscript + ../../qml exampledirs += ../../../examples/qml \ ../ \ diff --git a/src/qml/doc/snippets/qml/workerscript/script.mjs b/src/qml/doc/snippets/qml/workerscript/script.mjs deleted file mode 100644 index f55dee3507..0000000000 --- a/src/qml/doc/snippets/qml/workerscript/script.mjs +++ /dev/null @@ -1,4 +0,0 @@ -WorkerScript.onMessage = function(message) { - // ... long-running operations and calculations are done here - WorkerScript.sendMessage({ 'reply': 'Mouse is at ' + message.x + ',' + message.y }) -} diff --git a/src/qml/doc/snippets/qml/workerscript/workerscript.qml b/src/qml/doc/snippets/qml/workerscript/workerscript.qml deleted file mode 100644 index cc637d34cf..0000000000 --- a/src/qml/doc/snippets/qml/workerscript/workerscript.qml +++ /dev/null @@ -1,74 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//![0] -import QtQuick 2.0 - -Rectangle { - width: 300; height: 300 - - Text { - id: myText - text: 'Click anywhere' - } - - WorkerScript { - id: myWorker - source: "script.mjs" - - onMessage: myText.text = messageObject.reply - } - - MouseArea { - anchors.fill: parent - onClicked: myWorker.sendMessage({ 'x': mouse.x, 'y': mouse.y }) - } -} -//![0] diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index b2d322465d..67c0f6bb25 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -275,6 +275,7 @@ /*! \fn int qmlRegisterAnonymousType(const char *uri, int versionMajor) + \relates QQmlEngine This template function registers the C++ type in the QML system as an anonymous type. The resulting QML type does not have a name. Therefore, instances of this type cannot be created from diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp index c1c971f0a9..a1087a0034 100644 --- a/src/qml/qml/qqmlextensionplugin.cpp +++ b/src/qml/qml/qqmlextensionplugin.cpp @@ -102,13 +102,10 @@ QUrl QQmlExtensionPlugin::baseUrl() const } /*! - \fn void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri) - Initializes the extension from the \a uri using the \a engine. Here an application plugin might, for example, expose some data or objects to QML, as context properties on the engine's root context. */ - void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri) { Q_UNUSED(engine); diff --git a/src/qml/qml/qqmlinfo.cpp b/src/qml/qml/qqmlinfo.cpp index 2bfd2d5bb4..dd401bdb20 100644 --- a/src/qml/qml/qqmlinfo.cpp +++ b/src/qml/qml/qqmlinfo.cpp @@ -57,7 +57,6 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlDebug(const QObject *object) - \relates QtQml \since 5.9 Prints debug messages that include the file and line number for the @@ -91,7 +90,6 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlInfo(const QObject *object) - \relates QtQml Prints informational messages that include the file and line number for the specified QML \a object. @@ -119,7 +117,6 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlWarning(const QObject *object) - \relates QtQml \since 5.9 Prints warning messages that include the file and line number for the diff --git a/src/qmlmodels/doc/images/listmodel-nested.png b/src/qmlmodels/doc/images/listmodel-nested.png new file mode 100644 index 0000000000..ee7ffba67a Binary files /dev/null and b/src/qmlmodels/doc/images/listmodel-nested.png differ diff --git a/src/qmlmodels/doc/images/listmodel.png b/src/qmlmodels/doc/images/listmodel.png new file mode 100644 index 0000000000..7ab1771f15 Binary files /dev/null and b/src/qmlmodels/doc/images/listmodel.png differ diff --git a/src/qmlmodels/doc/images/objectmodel.png b/src/qmlmodels/doc/images/objectmodel.png new file mode 100644 index 0000000000..5e6d1325b2 Binary files /dev/null and b/src/qmlmodels/doc/images/objectmodel.png differ diff --git a/src/qmlmodels/doc/qtqmlmodels.qdocconf b/src/qmlmodels/doc/qtqmlmodels.qdocconf index a4153f4a53..3364988559 100644 --- a/src/qmlmodels/doc/qtqmlmodels.qdocconf +++ b/src/qmlmodels/doc/qtqmlmodels.qdocconf @@ -23,15 +23,18 @@ qhp.QtQmlModels.sortPages = true tagfile = qtqmlmodels.tags -depends += qtcore qtqml qtdoc +depends += qtcore qtqml qtquick qtdoc qtqmlworkerscript qtquickcontrols qtxmlpatterns -headerdirs += .. +headerdirs += .. \ + ../../imports/labsmodels sourcedirs += .. \ - ../../imports/models + ../../imports/models \ + ../../imports/labsmodels -exampledirs += ../../../examples/qml \ - ../ \ +exampledirs += .. \ snippets +imagedirs += images + navigation.qmltypespage = "Qt Qml Models QML Types" diff --git a/src/qmlmodels/qqmllistmodel.cpp b/src/qmlmodels/qqmllistmodel.cpp index e0a66e7170..f79910204a 100644 --- a/src/qmlmodels/qqmllistmodel.cpp +++ b/src/qmlmodels/qqmllistmodel.cpp @@ -1905,11 +1905,11 @@ void DynamicRoleModelNodeMetaObject::propertyWritten(int index) Here is an example that uses WorkerScript to periodically append the current time to a list model: - \snippet ../quick/threading/threadedlistmodel/timedisplay.qml 0 + \snippet ../../examples/quick/threading/threadedlistmodel/timedisplay.qml 0 The included file, \tt dataloader.mjs, looks like this: - \snippet ../quick/threading/threadedlistmodel/dataloader.mjs 0 + \snippet ../../examples/quick/threading/threadedlistmodel/dataloader.mjs 0 The timer in the main example sends messages to the worker script by calling \l WorkerScript::sendMessage(). When this message is received, diff --git a/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf index bb883cf39f..e56e1759b3 100644 --- a/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf +++ b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf @@ -23,15 +23,13 @@ qhp.QtQmlWorkerScript.sortPages = true tagfile = qtqmlworkerscript.tags -depends += qtcore qtqml qtdoc +depends += qtcore qtqml qtquick qtdoc headerdirs += .. sourcedirs += .. \ ../../imports/workerscript -exampledirs += ../../../examples/qml \ - ../ \ - snippets +exampledirs += snippets navigation.qmltypespage = "Qt Qml WorkerScript QML Types" diff --git a/src/qmlworkerscript/doc/snippets/qml/workerscript/script.mjs b/src/qmlworkerscript/doc/snippets/qml/workerscript/script.mjs new file mode 100644 index 0000000000..f55dee3507 --- /dev/null +++ b/src/qmlworkerscript/doc/snippets/qml/workerscript/script.mjs @@ -0,0 +1,4 @@ +WorkerScript.onMessage = function(message) { + // ... long-running operations and calculations are done here + WorkerScript.sendMessage({ 'reply': 'Mouse is at ' + message.x + ',' + message.y }) +} diff --git a/src/qmlworkerscript/doc/snippets/qml/workerscript/workerscript.qml b/src/qmlworkerscript/doc/snippets/qml/workerscript/workerscript.qml new file mode 100644 index 0000000000..cc637d34cf --- /dev/null +++ b/src/qmlworkerscript/doc/snippets/qml/workerscript/workerscript.qml @@ -0,0 +1,74 @@ +/**************************************************************************** +** +** Copyright (C) 2017 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//![0] +import QtQuick 2.0 + +Rectangle { + width: 300; height: 300 + + Text { + id: myText + text: 'Click anywhere' + } + + WorkerScript { + id: myWorker + source: "script.mjs" + + onMessage: myText.text = messageObject.reply + } + + MouseArea { + anchors.fill: parent + onClicked: myWorker.sendMessage({ 'x': mouse.x, 'y': mouse.y }) + } +} +//![0] diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf index 91458527dd..0d46e3408d 100644 --- a/src/quick/doc/qtquick.qdocconf +++ b/src/quick/doc/qtquick.qdocconf @@ -38,7 +38,7 @@ qhp.QtQuick.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtquick/qtquick.tags -depends += qtcore qtqml qtqmltest qtgui qtlinguist qtquickcontrols qtquickcontrols1 qtdoc qtquickdialogs qtsensors qtwidgets qmake qtmultimedia qtgraphicaleffects qtsql qtxmlpatterns +depends += qtcore qtqml qtqmlmodels qtqmltest qtgui qtlinguist qtquickcontrols qtquickcontrols1 qtdoc qtquickdialogs qtsensors qtwidgets qmake qtmultimedia qtgraphicaleffects qtsql qtxmlpatterns headerdirs += ..\ ../../quick \ @@ -70,6 +70,9 @@ sourcedirs += ../../plugins #exclude certain directories excludedirs += ../../imports/models \ + ../../imports/labsmodels \ + ../../imports/testlib \ + ../../imports/workerscript \ ../../imports/statemachine excludefiles += ../util/qquickpropertychanges_p.h diff --git a/src/quick/doc/snippets/cmake-macros/examples.cmake b/src/quick/doc/snippets/cmake-macros/examples.cmake index 8ca6180f9b..cecc59debc 100644 --- a/src/quick/doc/snippets/cmake-macros/examples.cmake +++ b/src/quick/doc/snippets/cmake-macros/examples.cmake @@ -3,4 +3,4 @@ find_package(Qt5 COMPONENTS Quick QmlImportScanner) add_executable(myapp main.cpp) target_link_libraries(myapp Qt5::Quick) qt5_import_qml_plugins(myapp) -#! [qt5_import_plugins] +#! [qt5_import_qml_plugins] diff --git a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc index e83aa39734..88003b68d3 100644 --- a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc @@ -55,7 +55,7 @@ appropriate for the various graphics APIs. Unlike \c software or \c d3d12, the RHI-based renderer is not an additional adaptation, and is always built-in. As of Qt 5.14 it can be enabled by setting the environment variable \c{QSG_RHI} to a non-zero value before starting the -application, or via \l QQuickWindow::setScenegraphBackend() in combination with +application, or via \l QQuickWindow::setSceneGraphBackend() in combination with \l QSGRendererInterface::GraphicsApi. When none of this is done, OpenGL is used directly like in previous versions. diff --git a/src/quick/handlers/qquickwheelhandler.cpp b/src/quick/handlers/qquickwheelhandler.cpp index 90e4fef97e..aef2e8ebfb 100644 --- a/src/quick/handlers/qquickwheelhandler.cpp +++ b/src/quick/handlers/qquickwheelhandler.cpp @@ -49,6 +49,7 @@ Q_LOGGING_CATEGORY(lcWheelHandler, "qt.quick.handler.wheel") /*! \qmltype WheelHandler \instantiates QQuickWheelHandler + \inherits SinglePointHandler \inqmlmodule QtQuick \ingroup qtquick-input-handlers \brief Handler for the mouse wheel. @@ -71,7 +72,7 @@ Q_LOGGING_CATEGORY(lcWheelHandler, "qt.quick.handler.wheel") \snippet pointerHandlers/handlerFlick.qml 0 - Alternatively if \l targetProperty is not set or \l target is null, + Alternatively, if \l property is not set or \l target is null, WheelHandler will not automatically manipulate anything; but the \l rotation property can be used in a binding to manipulate another property, or you can implement \c onWheel and handle the wheel event @@ -79,15 +80,16 @@ Q_LOGGING_CATEGORY(lcWheelHandler, "qt.quick.handler.wheel") WheelHandler handles only a rotating mouse wheel by default. Optionally it can handle smooth-scrolling events from touchpad gestures, - by setting \l acceptedDevices to \c{PointerDevice.Mouse | PointerDevice.TouchPad}. + by setting \l {QtQuick::PointerDeviceHandler::}{acceptedDevices} to + \c{PointerDevice.Mouse | PointerDevice.TouchPad}. \note Some non-mouse hardware (such as a touch-sensitive Wacom tablet, or a Linux laptop touchpad) generates real wheel events from gestures. WheelHandler will respond to those events as wheel events regardless of the - setting of the \l acceptedDevices property. + setting of the \l {QtQuick::PointerDeviceHandler::}{acceptedDevices} + property. - \sa MouseArea - \sa Flickable + \sa MouseArea, Flickable */ QQuickWheelHandler::QQuickWheelHandler(QQuickItem *parent) @@ -125,13 +127,13 @@ void QQuickWheelHandler::setOrientation(Qt::Orientation orientation) \qmlproperty bool QtQuick::WheelHandler::invertible Whether or not to reverse the direction of property change if - \l QQuickPointerScrollEvent::inverted is true. The default is \c true. + QQuickPointerScrollEvent::inverted is true. The default is \c true. If the operating system has a "natural scrolling" setting that causes scrolling to be in the same direction as the finger movement, then if this property is set to \c true, and WheelHandler is directly setting a property on \l target, the direction of movement will correspond to the system setting. - If this property is set to \l false, it will invert the \l rotation so that + If this property is set to \c false, it will invert the \l rotation so that the direction of motion is always the same as the direction of finger movement. */ bool QQuickWheelHandler::isInvertible() const diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index 4c20b7e2e1..3785abc450 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -2074,10 +2074,10 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus) in the GPU equal to \c {width x height x 4}. In memory constrained configurations, large layers should be used with care. - In the QPainter / QWidget world, it is some times favorable to + In the QPainter / QWidget world, it is sometimes favorable to cache complex content in a pixmap, image or texture. In Qt Quick, because of the techniques already applied by the \l {Qt Quick - Scene Graph OpenGL Renderer} {scene graph renderer}, this will in most + Scene Graph Default Renderer} {scene graph renderer}, this will in most cases not be the case. Excessive draw calls are already reduced because of batching and a cache will in most cases end up blending more pixels than the original content. The overhead of rendering diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp index 8b70ffd0d7..18a9afbad8 100644 --- a/src/quick/items/qquicklistview.cpp +++ b/src/quick/items/qquicklistview.cpp @@ -2078,7 +2078,7 @@ QQuickListView::~QQuickListView() highlight item is \c 0. \sa highlightItem, highlightFollowsCurrentItem, - {Qt Quick Examples - Views#Highlight}{ListView highlight example}, + {Qt Quick Examples - Views#Using Highlight}{ListView Highlight Example}, {Stacking Order in ListView} */ diff --git a/src/quick/items/qquickview.cpp b/src/quick/items/qquickview.cpp index 17fc16d44b..2110d4caba 100644 --- a/src/quick/items/qquickview.cpp +++ b/src/quick/items/qquickview.cpp @@ -240,13 +240,12 @@ void QQuickView::setSource(const QUrl& url) } /*! - Sets the initial properties with which the QML component gets initialized after - calling \l QQuickView::setSource. + Sets the initial properties \a initialProperties with which the QML + component gets initialized after calling \l QQuickView::setSource(). + \note You can only use this function to initialize top-level properties. - Note that you can only use this function to initialize toplevel properties. - - \sa QQmlComponent::createWithInitialProperties + \sa QQmlComponent::createWithInitialProperties() \since 5.14 */ void QQuickView::setInitialProperties(const QVariantMap &initialProperties) diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp index 8fb023cf61..faa22ec83f 100644 --- a/src/quick/items/qquickwindow.cpp +++ b/src/quick/items/qquickwindow.cpp @@ -4592,7 +4592,7 @@ QSGTexture *QQuickWindow::createTextureFromId(uint id, const QSize &size, Create \a nativeLayout is only used for APIs like Vulkan. When applicable, it must specify the current image layout, such as, a VkImageLayout value. - \sa sceneGraphInitialized(), QSGTextures + \sa sceneGraphInitialized(), QSGTexture \since 5.14 */ diff --git a/src/quick/scenegraph/coreapi/qsgmaterialrhishader.cpp b/src/quick/scenegraph/coreapi/qsgmaterialrhishader.cpp index 117d477f9a..77593591bd 100644 --- a/src/quick/scenegraph/coreapi/qsgmaterialrhishader.cpp +++ b/src/quick/scenegraph/coreapi/qsgmaterialrhishader.cpp @@ -319,7 +319,7 @@ bool QSGMaterialRhiShader::updateUniformData(RenderState &state, each variable in the material's shaders' \l{QShaderDescription::combinedImageSamplers()}. - When \c{*texture} is null, it must be set to a QSGTexture pointer before + When *\a{texture} is null, it must be set to a QSGTexture pointer before returning. When non-null, it is up to the material to decide if a new \c{QSGTexture *} is stored to it, or if it updates some parameters on the already known QSGTexture. The ownership of the QSGTexture is not diff --git a/src/quick/scenegraph/coreapi/qsgtexture.cpp b/src/quick/scenegraph/coreapi/qsgtexture.cpp index edcee96bdb..dfbe4d3ffd 100644 --- a/src/quick/scenegraph/coreapi/qsgtexture.cpp +++ b/src/quick/scenegraph/coreapi/qsgtexture.cpp @@ -701,8 +701,8 @@ void QSGTexture::updateBindOptions(bool force) // legacy (GL-only) data (for example, because there was no setImage() since the last call to this function), the function does nothing. - Materials involving textures are expected to call this function from their - updateSampledImage() implementation, typically without any conditions. + Materials involving \a rhi textures are expected to call this function from + their updateSampledImage() implementation, typically without any conditions. \note This function is only used when running the graphics API independent rendering path of the scene graph. diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp index 61319c388c..24b22f00c1 100644 --- a/src/quick/util/qquickpath.cpp +++ b/src/quick/util/qquickpath.cpp @@ -918,7 +918,7 @@ QPointF QQuickPath::backwardsPointAt(const QPainterPath &path, const qreal &path When curves are present, the percentage argument is mapped to the \c t parameter of the Bezier equations. - \sa QPainterPath::pointAt + \sa QPainterPath::pointAtPercent() \since QtQuick 2.14 */ @@ -2370,8 +2370,8 @@ void QQuickPathPercent::setValue(qreal value) The example below creates a triangular path consisting of four vertices on the edge of the containing Shape's bounding box. - Through the containing shape's \l scale property, the path will be - rescaled together with its containing shape. + Through the containing shape's \l {QtQuick::Path::}{scale} property, + the path will be rescaled together with its containing shape. \qml PathPolyline { @@ -2488,7 +2488,7 @@ void QQuickPathPolyline::addToPath(QPainterPath &path, const QQuickPathData &/*d The example below creates a high voltage symbol by adding each path of the symbol to the list of paths. The coordinates of the vertices are normalized, and through the containing shape's - \l scale property, the path will be rescaled together with its containing shape. + \l {QtQuick::Path::}{scale} property, the path will be rescaled together with its containing shape. \qml PathMultiline { -- cgit v1.2.3