From d97d618a4884c2535ba787e774f0faa6bce82081 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 16 Apr 2019 10:31:40 +0200 Subject: Doc: Fix multiple documentation issues - 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 --- src/multimedia/doc/src/qtaudioengine.qdoc | 2 +- src/multimedia/doc/src/qtmultimedia5.qdoc | 29 +++++++++++++++++++++++------ 2 files changed, 24 insertions(+), 7 deletions(-) (limited to 'src/multimedia/doc/src') 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 */ -- cgit v1.2.3