diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-11-04 12:37:45 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-11-05 09:00:48 +0100 |
commit | 0b12055548a8781b0c328991c267d62222667e8e (patch) | |
tree | de91b0183203dd00318fed9fa5ca4cff6713142a /src/quick/doc | |
parent | c01ad45d67ec0ce96d6944496dc292a94f17efea (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/doc')
-rw-r--r-- | src/quick/doc/src/concepts/input/topic.qdoc | 3 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc | 6 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc | 6 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc | 12 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc | 12 | ||||
-rw-r--r-- | src/quick/doc/src/examples.qdoc | 1 | ||||
-rw-r--r-- | src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc | 8 | ||||
-rw-r--r-- | src/quick/doc/src/qmltypereference.qdoc | 6 | ||||
-rw-r--r-- | src/quick/doc/src/qtquick.qdoc | 6 | ||||
-rw-r--r-- | src/quick/doc/src/tutorial.qdoc | 3 |
10 files changed, 17 insertions, 46 deletions
diff --git a/src/quick/doc/src/concepts/input/topic.qdoc b/src/quick/doc/src/concepts/input/topic.qdoc index 95f4732f46..dd919c157e 100644 --- a/src/quick/doc/src/concepts/input/topic.qdoc +++ b/src/quick/doc/src/concepts/input/topic.qdoc @@ -67,7 +67,7 @@ events and key-presses, and displays the appropriate text. See the documentation about \l{qtquick-input-textinput.html}{text input} for in-depth information on the topic. - +\omit //! QtSensors \section1 Device Motion Gestures Detecting device gestures with an accelerometer, or through camera-based gesture @@ -78,6 +78,7 @@ and engaging experience. Qt Quick itself does not offer first-class support for physical device motion gestures; however, the \l{Qt Sensors} module provides QML types with support for such gestures. See the \l{Qt Sensors} module documentation for more information on the topic. +\endomit //! QtSensors */ diff --git a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc index 7695bb57db..73f5318921 100644 --- a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc +++ b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc @@ -36,7 +36,7 @@ Models can be defined in C++ and then made available to QML. This is useful for exposing existing C++ data models or otherwise complex datasets to QML. -A C++ model class can be defined as a \l QStringList, a \l QVariantList, a +A C++ model class can be defined as a \l QStringList, a \l {QVariant::}{QVariantList}, a QObjectList or a \l QAbstractItemModel. The first three are useful for exposing simpler datasets, while QAbstractItemModel provides a more flexible solution for more complex models. @@ -71,8 +71,8 @@ the model by calling QQmlContext::setContextProperty() again. \section2 QVariantList-based Model -A model may be a single \l QVariantList, which provides the contents of the list -via the \e modelData role. +A model may be a single \l {QVariant::}{QVariantList}, which provides the contents +of the list via the \e modelData role. The API works just like with \l QStringList, as shown in the previous section. diff --git a/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc b/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc index 4736dc7ddd..607479a03d 100644 --- a/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc +++ b/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc @@ -236,7 +236,7 @@ To visualize data, bind the view's \c model property to a model and the Even if subsequent roles are added, only the first two will be handled by views using the model. To reset the roles available in the model, call ListModel::clear(). - +\omit //! XmlListModel \section2 XML Model XmlListModel allows construction of a model from an XML data source. The roles @@ -264,7 +264,7 @@ To visualize data, bind the view's \c model property to a model and the The \l{Qt Quick Demo - RSS News}{RSS News demo} shows how XmlListModel can be used to display an RSS feed. - +\endomit \section2 Object Model @@ -431,7 +431,7 @@ ListView { \note The \c edit role is equal to \l Qt::EditRole. See \l{QAbstractItemModel::}{roleNames}() for the built-in role names. However, real life models would usually register custom roles. -\note If a model role is bound to a \l{Required Property}{required property}, assigning to +\note If a model role is bound to a \l{Required Properties}{required property}, assigning to that property will not modify the model. It will instead break the binding to the model (just like assigning to any other property breaks existing bindings). If you want to use required properties and change the model data, make model also a required property and assign to diff --git a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc index e330806c85..9d5c4aaf09 100644 --- a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc @@ -136,12 +136,6 @@ updates can significantly improve performance for many applications. ShaderEffect components in QtQuick 2 cannot be rendered by the Software adaptation. -\section2 Qt Graphical Effects Module - -\l {Qt Graphical Effects} uses ShaderEffect items to render effects. If you use graphical effects -from this module, then you should not hide the source item so that the original item can still be -rendered. - \section2 Particle Effects It is not possible to render particle effects with the Software adaptation. Whenever possible, @@ -209,12 +203,6 @@ to take advantage of Image Filter operations in the OpenVG API to get effects th what ShaderEffects provides in custom items. To integrate custom OpenVG rendering, use QSGRenderNode in combination with QSGRendererInterface. -\section2 Qt Graphical Effects Module - -\l {Qt Graphical Effects} uses ShaderEffect items to render effects. If you use graphical effects -from this module, then you shouldn't hide the source item so that the original item can still be -rendered. - \section2 Particle Effects It's not possible to render particle effects with the OpenVG adaptation. Whenever possible, remove diff --git a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc index 691988999b..faec8df7e4 100644 --- a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc @@ -145,9 +145,6 @@ type. Below is a complete list of material classes: \annotatedlist{qtquick-scenegraph-materials} -For more details, see the \l {Scene Graph - Simple Material} - - \section2 Convenience Nodes The scene graph API is low-level and focuses on performance rather than @@ -196,7 +193,7 @@ the CPU at 100%. If a system is known to be unable to provide vsync-based throttling, use the \c basic render loop instead by setting \c {QSG_RENDER_LOOP=basic} in the environment. -\section2 Threaded Render Loop ("threaded") +\section2 Threaded Render Loop ('threaded') On many configurations, the scene graph rendering will happen on a dedicated render thread. This is done to increase parallelism of @@ -279,7 +276,7 @@ change in future releases. It is always possible to force use of the threaded renderer by setting \c {QSG_RENDER_LOOP=threaded} in the environment. -\section2 Non-threaded Render Loop ("basic") +\section2 Non-threaded Render Loop ('basic') The non-threaded render loop is currently used by default on Windows with OpenGL when not using the system's standard opengl32.dll, \macos with OpenGL, @@ -346,10 +343,7 @@ how to use these signals using Vulkan. The other alternative, only available for OpenGL currently, is to create a QQuickFramebufferObject, render into it, and let it be displayed in the scene graph as a texture. The \l {Scene Graph - Rendering FBOs} example shows how -this can be done. It is also possible to combine multiple rendering contexts -and multiple threads to create content to be displayed in the scene graph. The -\l {Scene Graph - Rendering FBOs in a thread} examples show how this can be -done. +this can be done. Graphics APIs other than OpenGL can also follow this approach, even though QQuickFramebufferObject does not currently support them. Creating and rendering diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc index d24964f8b1..6ba7d701fc 100644 --- a/src/quick/doc/src/examples.qdoc +++ b/src/quick/doc/src/examples.qdoc @@ -123,7 +123,6 @@ Creator. \b{QML Types and Controls} \list \li \l{Qt Quick Controls - Gallery}{Controls Gallery} - \li \l{Qt Quick System Dialog Examples}{Dialog Examples} \li \l{Calendar Example} \li \l{tableview/gameoflife}{TableView} \li \l{Qt Quick Examples - Text}{Text and Fonts} diff --git a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc index e3353ef077..07934ad232 100644 --- a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc +++ b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc @@ -111,7 +111,7 @@ integrating 3rd party tools such as QmlLive and GammaRay. \endlist \section1 qmllint -qmllint is a tool shipped with Qt, that verifies the syntatic validity of QML files. +\e qmllint is a tool shipped with Qt, that verifies the syntatic validity of QML files. It also warns about some QML anti-patterns. If you want to disable a specific warning type, you can find the appropriate flag for doing so by passing \c{--help} on the command line. @@ -130,12 +130,12 @@ via the -I flag. \section2 Related Information \list - \li \l{qmltypes} + \li \l{Writing a qmltypes File}{qmltypes} \endlist \section1 qmlformat -qmlformat is a tool that automatically formats QML files in accordance +\e qmlformat is a tool that automatically formats QML files in accordance with the \l{QML Coding Conventions}. The tool groups all properties, functions, and signals together, instead of @@ -148,5 +148,5 @@ By default, qmlformat writes the formatted version of the file to stdout. If you wish to have your file updated in-place specify the \c{-i} flag. \section2 Related Information -\sa \l{QML Coding Conventions} +\sa {QML Coding Conventions} */ diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index 528444cad3..af46c5dcc3 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -49,16 +49,10 @@ information about the concepts which are central to \c QtQuick. Qt Quick includes several submodules which contain additional types. \list - \li \l{Qt Quick XmlListModel QML Types}{Xml List Model} - contains types - for creating models from XML data \li \l{Qt Quick Local Storage QML Types}{Local Storage} - a submodule containing a JavaScript interface for an SQLite database \li \l{Qt Quick Particles QML Types}{Particles} - provides a particle system for QML applications - \li \l{Qt Quick Window QML Types}{Window} - contains types for creating - top-level windows and accessing screen information - \li \l{Qt Quick Dialogs QML Types}{Dialogs} - contains types for creating and - interacting with system dialogs \li \l{Qt Quick Controls QML Types}{Controls} - provides a set of reusable UI components \li \l{Qt Quick Layouts QML Types}{Layouts} - contains types that are used diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index 4b843f366b..da370d7828 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -104,17 +104,11 @@ Additional Qt Quick information: \li \l{Qt Quick QML Types} - a list of QML types provided by the \c{QtQuick} import \list - \li \l{Qt Quick XmlListModel QML Types}{XML List Model} - contains types - for creating models from XML data \li \l{Qt Quick Local Storage QML Types}{Local Storage} - a submodule containing a JavaScript interface for an SQLite database \li \l{Qt Quick Particles QML Types}{Particles} - provides a particle system for Qt Quick \li \l{Qt Quick Layouts}{Layouts} - provides layouts for arranging Qt Quick items - \li \l{Qt Quick Window QML Types}{Window} - contains types for creating - top-level windows and accessing screen information - \li \l{Qt Quick Dialogs}{Dialogs} - contains types for creating and - interacting with system dialogs \li \l{Qt Quick Test QML Types}{Tests} - contains types for writing unit test for a QML application \endlist \li \l{Qt Quick Examples and Tutorials} diff --git a/src/quick/doc/src/tutorial.qdoc b/src/quick/doc/src/tutorial.qdoc index 7cb5f655e8..e84753d895 100644 --- a/src/quick/doc/src/tutorial.qdoc +++ b/src/quick/doc/src/tutorial.qdoc @@ -220,5 +220,6 @@ This is equivalent to writing the two transitions separately. The \l ParallelAnimation type makes sure that the two types of animations (number and color) start at the same time. We could also run them one after the other by using \l SequentialAnimation instead. -For more details on states and transitions, see \l {Qt Quick States} and the \l{animation/states}{states and transitions example}. +For more details on states and transitions, see \l {Qt Quick States} and the +\l{Qt Quick Examples - Animation#States}{states and transitions example}. */ |