diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-04-16 10:31:40 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2019-04-16 09:32:56 +0000 |
commit | d97d618a4884c2535ba787e774f0faa6bce82081 (patch) | |
tree | 81a493c10a27f8a5f52cace24c9cf7330b8e3faa /examples/multimedia/video/doc/src/qmlvideofx.qdoc | |
parent | d55edfc3cf6b65949835586b4b216cfd672c8380 (diff) |
Doc: Fix multiple documentation issuesv5.13.0-beta3
- GstTools has some (internal) documentation, but was causing a number of
warnings with QDoc's clang parser - exclude it from the documentation
build.
- Remove direct links from example documentation to individual example
files; they no longer work.
- Fix navigation for QML types; The main QML types pages did not list
types for QtAudioEngiine.
- Use \QtMinorVersion macro to make the documented import versions
follow the minor Qt version.
- Fix \since usage to be consistent throughout.
- Fix linking issues for QML properties/methods
- Minor language fixes
Change-Id: I735cd13fa6dedd6bf06d6b6ef50ce2e0d69a545b
Reviewed-by: VaL Doroshchuk <valentyn.doroshchuk@qt.io>
Diffstat (limited to 'examples/multimedia/video/doc/src/qmlvideofx.qdoc')
-rw-r--r-- | examples/multimedia/video/doc/src/qmlvideofx.qdoc | 38 |
1 files changed, 17 insertions, 21 deletions
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc index af01e4286..ca0a4af9d 100644 --- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc +++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc @@ -64,13 +64,13 @@ This image shows a 'wobble' effect applied to the viewfinder. The application includes many more effects than the ones shown here - look for Effect*.qml files in the list of files below to see the full range. -\section1 Application structure +\section1 Application Structure Shader effects can be applied to video or viewfinder content using \l{ShaderEffect}, as shown in the following example, which applies a wiggly effect to the content: -\code +\qml import QtQuick 2.0 import QtMultimedia 5.0 @@ -109,7 +109,7 @@ Rectangle { " } } -\endcode +\endqml In this application, the usage of the \l{ShaderEffect} and \l{VideoOutput} types is a bit more complicated, for the following reasons: @@ -127,9 +127,9 @@ types is a bit more complicated, for the following reasons: to uniform values passed into the GLSL code \endlist -The abstraction of source item type is achieved by the -\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a -\l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image}: +The abstraction of source item type is achieved by the \c Content, which uses a +\l[QML]{Loader} to create either a \l[QML]{MediaPlayer}, \l[QML]{Camera}, or an +\l[QML]{Image}: \quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml \skipto import @@ -157,9 +157,8 @@ The abstraction of source item type is achieved by the \skipto /^\}/ \printuntil } -Each effect is implemented as a QML item which is based on the -\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn -is based on the \l{ShaderEffect}: +Each effect is implemented as a QML item which is based on the \c Effect, which in +turn is based on the \l[QML]{ShaderEffect}: \quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml \skipto import @@ -177,21 +176,18 @@ that the divider should be displayed. \skipto import \printuntil /^\}/ -The main.qml file shows a -\l{multimedia/video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows -the user to select the input source and an EffectSelectionPanel +The main.qml file shows a \c FileOpen item, which allows +the user to select the input source and an \c EffectSelectionList item, which lists each of the available shader effects. As described above, a -\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the -appropriate input and effect type. A -\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the -vertical dividing line, which can be dragged left / right by the user. Finally, -a \l{multimedia/video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item -renders the sliders corresponding to each effect parameter. - -Here is the effect selection menu: +\c Content item is used to load the appropriate input and effect type. A +\c Divider item draws the vertical dividing line, which can be dragged left or +right by the user. Finally, a \c ParameterPanel item renders the sliders +corresponding to each effect parameter. + \image qmlvideofx-effects-menu.jpg +\caption The effect selection menu -\section1 Calculating and displaying QML painting rate +\section1 Calculating and Displaying QML Painting Rate \input multimedia/doc/src/examples/video-qml-paint-rate.qdocinc |