diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2020-09-24 08:46:11 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2020-10-29 09:40:31 +0100 |
commit | c32b298024f2c1e1ee74c5ee3d73b626b46053aa (patch) | |
tree | 88f9a78796fae63be7a043c06a67cb17a144afdc /doc/src/qmlapp | |
parent | eba088a67dc36037484a9c13e8c221488b1d4db0 (diff) |
Doc: Fix QDoc warnings in qtdoc
Task-number: QTBUG-86800
Change-Id: I00d2adb94ca024a54415fed4dbd7bb9df4ff10bb
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'doc/src/qmlapp')
-rw-r--r-- | doc/src/qmlapp/usecases/layouts.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qmlapp/usecases/styling.qdoc | 28 | ||||
-rw-r--r-- | doc/src/qmlapp/usecases/userinput.qdoc | 15 | ||||
-rw-r--r-- | doc/src/qmlapp/usecases/visual.qdoc | 2 |
4 files changed, 28 insertions, 19 deletions
diff --git a/doc/src/qmlapp/usecases/layouts.qdoc b/doc/src/qmlapp/usecases/layouts.qdoc index ad995eec1..1febd4b01 100644 --- a/doc/src/qmlapp/usecases/layouts.qdoc +++ b/doc/src/qmlapp/usecases/layouts.qdoc @@ -71,7 +71,7 @@ For the common case of wanting to \e position a set of types in a regular patter types. Items placed in a positioner are automatically positioned in some way; for example, a \l [QML] Row positions items to be horizontally adjacent (forming a row). -For full details see \l {Item Positioners} and the documentation for \l{Qt Positioning QML Types}{the positioner types}. +For full details see \l {Item Positioners}. \snippet qmlapp/usecases/layouts.qml import \snippet qmlapp/usecases/layouts.qml positioners diff --git a/doc/src/qmlapp/usecases/styling.qdoc b/doc/src/qmlapp/usecases/styling.qdoc index 034fdda66..81c9885e9 100644 --- a/doc/src/qmlapp/usecases/styling.qdoc +++ b/doc/src/qmlapp/usecases/styling.qdoc @@ -34,24 +34,27 @@ or by directly assigning a value to a property. For types that incorporate Qt Quick's \l{Models and Views in Qt Quick}{delegates} the visual type attaches to the \e delegate property. -When using \l{Qt Quick Controls 1}, the controls automatically set +\omit +When using Qt Quick Controls 1, the controls automatically set the appropriate style from the respective \l{Supported Platforms}{platforms}. +\endomit +\omit \section1 Using the Styling QML Types -The \l{Qt Quick Controls 1}{controls} have a \c style property to which the -\e{styling types} bind. The controls have a corresponding styling type from the -\l{Qt Quick Controls 1 Styles QML Types}{Qt Quick Controls 1 Styles} module. -For example, \l [QtQuickControls1] Button has a -\l [QtQuickControls1] ButtonStyle type and \l [QtQuickControls1] Menu has a -\l [QtQuickControls1] MenuStyle type. The styling types provide properties -applicable to their respective controls such as the background, label, or for -some controls, the cursor appearance. +The Qt Quick Controls 1 controls have a \c style property to which the +\e{styling types} bind. The controls have a corresponding styling type +from the Qt Quick Controls 1 Styles QML Types module. +For example, QtQuickControls1 Button has a ButtonStyle type and Menu +has a MenuStyle type. The styling types provide properties +applicable to their respective controls such as the background, label, +or for some controls, the cursor appearance. \snippet qmlapp/usecases/styling.qml 0 -\note \l{Qt Quick Controls 1 Styles QML Types}{Qt Quick Controls 1 Styles} was -introduced in Qt 5.1 and requires \l{Qt Quick} 2.1. +\note Qt Quick Controls 1 Styles was introduced in Qt 5.1 and requires +\l{Qt Quick} 2.1. +\endomit \section1 Accessing the System Palette @@ -61,6 +64,5 @@ of visual types to match the native look and feel. In addition, on \l{Desktop Platforms}{desktop} platforms, different color palettes are employed when changing states, for example, when the application loses keyboard focus. -When using the \l{Qt Quick Controls 1}{controls}, the system colors are already -used. +When using the controls, the system colors are already used. */ diff --git a/doc/src/qmlapp/usecases/userinput.qdoc b/doc/src/qmlapp/usecases/userinput.qdoc index 1ffbe6b81..89f8c3ff1 100644 --- a/doc/src/qmlapp/usecases/userinput.qdoc +++ b/doc/src/qmlapp/usecases/userinput.qdoc @@ -33,12 +33,17 @@ The \l {Qt Quick} module provides support for the most common types of user input, including mouse and touch events, text input, and key-press events. Other -modules provide support for other types of user input for example, the -\l {Qt Sensors} module provides support for shake-gestures in QML applications. +modules provide support for other types of user input. +\omit +For example, the \l {Qt Sensors} module provides support for shake-gestures +in QML applications. +\endomit -This article covers how to handle basic user input; for further information -about motion-gesture support, see the \l {Qt Sensors} documentation. For -information about audio-visual input, see the \l {Qt Multimedia} documentation. +This article covers how to handle basic user input. +\omit +For further information about motion-gesture support, see the +\l {Qt Sensors} documentation. For information about audio-visual input, see the \l {Qt Multimedia} documentation. +\endomit \section2 Mouse and touch events diff --git a/doc/src/qmlapp/usecases/visual.qdoc b/doc/src/qmlapp/usecases/visual.qdoc index 719c2b3a4..70e39cbff 100644 --- a/doc/src/qmlapp/usecases/visual.qdoc +++ b/doc/src/qmlapp/usecases/visual.qdoc @@ -54,7 +54,9 @@ borders. \l AnimatedImage plays animated .gif and .mng images. \l AnimatedSprite and \l SpriteSequence play animations comprised of multiple frames stored adjacently in a non animated image format. +\omit For displaying video files and camera data, see the \l {Qt Multimedia} module. +\endomit \section1 Shared Visual Properties |