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 /src/multimedia/doc | |
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 'src/multimedia/doc')
-rw-r--r-- | src/multimedia/doc/QtMultimediaDoc | 1 | ||||
-rw-r--r-- | src/multimedia/doc/qtmultimedia.qdocconf | 4 | ||||
-rw-r--r-- | src/multimedia/doc/src/qtaudioengine.qdoc | 2 | ||||
-rw-r--r-- | src/multimedia/doc/src/qtmultimedia5.qdoc | 29 |
4 files changed, 26 insertions, 10 deletions
diff --git a/src/multimedia/doc/QtMultimediaDoc b/src/multimedia/doc/QtMultimediaDoc index 5723c2a78..e57c3595b 100644 --- a/src/multimedia/doc/QtMultimediaDoc +++ b/src/multimedia/doc/QtMultimediaDoc @@ -1,3 +1,2 @@ #include <QtMultimedia/QtMultimedia> #include <QtMultimediaWidgets/QtMultimediaWidgets> -#include "../gsttools_headers/qgstutils_p.h" diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index b547db762..256ad261e 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -56,9 +56,9 @@ imagedirs += src/images \ sourcedirs += ../.. -#excludedirs += ../../multimediawidgets +excludedirs += ../../gsttools -depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets +depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork navigation.landingpage = "Qt Multimedia" navigation.cppclassespage = "Qt Multimedia C++ Classes" diff --git a/src/multimedia/doc/src/qtaudioengine.qdoc b/src/multimedia/doc/src/qtaudioengine.qdoc index bf8be899e..c45d4e8af 100644 --- a/src/multimedia/doc/src/qtaudioengine.qdoc +++ b/src/multimedia/doc/src/qtaudioengine.qdoc @@ -55,5 +55,5 @@ SoundInstance for easier QML bindings. \li \l {AudioEngine Example}{Audio Engine} \endlist -\section1 QML types +\section1 QML Types */ diff --git a/src/multimedia/doc/src/qtmultimedia5.qdoc b/src/multimedia/doc/src/qtmultimedia5.qdoc index aec3d99d0..a2aaa1a80 100644 --- a/src/multimedia/doc/src/qtmultimedia5.qdoc +++ b/src/multimedia/doc/src/qtmultimedia5.qdoc @@ -39,11 +39,28 @@ The QML types for \l{Qt Multimedia} support the basic use cases such as: \li and access camera settings. \endlist -The QML types can be imported into your application using the following import -statement in your .qml file: -\code -import QtMultimedia 5.8 -\endcode +\section1 QML Types -\section1 QML types +Qt Multimedia QML types can be imported into your application using the +following import statement in your .qml file: + +\qml \QtMinorVersion +import QtMultimedia 5.\1 +\endqml + +\generatelist qmltypesbymodule QtMultimedia + +\section2 Qt Audio Engine + +\l {QtAudioEngine}{Qt Audio Engine} provides types for 3D positional audio +playback and content management. These types can be imported into your +application using the following import statement in your .qml file: + +\qml \QtMinorVersion +import QtAudioEngine 1.\1 +\endqml + +\generatelist qmltypesbymodule QtAudioEngine + +\noautolist */ |