summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-04-16 10:31:40 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2019-04-16 09:32:56 +0000
commitd97d618a4884c2535ba787e774f0faa6bce82081 (patch)
tree81a493c10a27f8a5f52cace24c9cf7330b8e3faa
parentd55edfc3cf6b65949835586b4b216cfd672c8380 (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>
-rw-r--r--examples/multimedia/video/doc/src/qmlvideo.qdoc54
-rw-r--r--examples/multimedia/video/doc/src/qmlvideofx.qdoc38
-rw-r--r--src/imports/audioengine/qdeclarative_sound_p.cpp9
-rw-r--r--src/imports/audioengine/qdeclarative_soundinstance_p.cpp14
-rw-r--r--src/imports/multimedia/qdeclarativeaudio.cpp12
-rw-r--r--src/imports/multimedia/qdeclarativecamera.cpp12
-rw-r--r--src/imports/multimedia/qdeclarativecameraflash.cpp4
-rw-r--r--src/imports/multimedia/qdeclarativecameraimageprocessing.cpp4
-rw-r--r--src/imports/multimedia/qdeclarativemultimediaglobal.cpp2
-rw-r--r--src/imports/multimedia/qdeclarativeplaylist.cpp10
-rw-r--r--src/imports/multimedia/qdeclarativeradio.cpp2
-rw-r--r--src/multimedia/audio/qaudiobuffer.cpp5
-rw-r--r--src/multimedia/doc/QtMultimediaDoc1
-rw-r--r--src/multimedia/doc/qtmultimedia.qdocconf4
-rw-r--r--src/multimedia/doc/src/qtaudioengine.qdoc2
-rw-r--r--src/multimedia/doc/src/qtmultimedia5.qdoc29
-rw-r--r--src/qtmultimediaquicktools/qdeclarativevideooutput.cpp4
17 files changed, 104 insertions, 102 deletions
diff --git a/examples/multimedia/video/doc/src/qmlvideo.qdoc b/examples/multimedia/video/doc/src/qmlvideo.qdoc
index 736cffa8..b8ab25d0 100644
--- a/examples/multimedia/video/doc/src/qmlvideo.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideo.qdoc
@@ -50,16 +50,14 @@ which moves across the \l{VideoOutput} item.
\section1 Application Structure
-The \l{multimedia/video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
-the following items:
+The \c main.qml file creates a UI which includes the following items:
\list
- \li Two \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each
- of which displays a filename, and can be used to launch a
- \l{multimedia/video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
- \li An exit \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
- \li A \l{multimedia/video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
- which is a flickable list displaying the available scenes
+ \li Two \c Button instances, each of which displays a filename, and can be
+ used to launch a \c FileBrowser.
+ \li An exit \c Button.
+ \li A \c SceneSelectionPanel, which is a flickable list displaying the
+ available scenes.
\li At the lower left, an item which displays the QML repainting rate - the
upper number is the instantaneous frame rate and the lower number is the
average over the past second.
@@ -69,17 +67,15 @@ the following items:
Each scene in the flickable list is implemented in its own QML file - for
example the video-basic scene (which just displays a static \l{VideoOutput}
-in the center of the screen) is implemented in the
-\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you
-can see from the code, this makes use of a type of inheritance: a
-\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
+in the center of the screen) is implemented in the \c VideoBasic.qml file. As
+you can see from the code, this makes use of a type of inheritance; a
+\c VideoBasic item ...
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml
\skipto import
\printuntil /^\}/
-... is-a
-\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
+... is of type \c SceneBasic ...
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml
\skipto import
@@ -91,8 +87,7 @@ can see from the code, this makes use of a type of inheritance: a
\skipto }
\printuntil /^\}/
-... which is-a
-\l{multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
+... which itself is a \c Scene:
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml
\skipto import
@@ -104,33 +99,28 @@ can see from the code, this makes use of a type of inheritance: a
\skipto Button
\printuntil /^\}/
-\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the
-structure and behaviour of the scene, but is agnostic of the type of content
-which will be displayed - this is abstracted by
-\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
+\c SceneBasic describes the structure and behavior of the scene, but is
+agnostic of the type of content which will be displayed - this is abstracted
+by \c Content.
This pattern allows us to define a particular use case (in this case, simply
display a static piece of content), and then instantiate that use case for
-both video content
-(\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and camera content
-(\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach
-is used to implement many of the other scenes - for example, "repeatedly slide
-the content from left to right and back again" is implemented by
-\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
-\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
-\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
+both video content (\c {VideoBasic}) and camera content \c ({CameraBasic}).
+This approach is used to implement many of the other scenes - for example,
+\e {"repeatedly slide the content from left to right and back again"} is
+implemented by \c SceneMove, on which \c VideoMove and \c CameraMove are based.
Depending on the value of the contentType property in the top-level scene
-instance, the embedded
-\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
-\l{MediaPlayer} or a \l{Camera} item.
+instance, the embedded \c Content item creates either a
+\l[QML]{MediaPlayer} or a \l[QML]{Camera} item.
\section1 Calculating and Displaying QML Painting Rate
\input multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
All that remains is to connect the afterRendering() signal of the QQuickView
-object to a JavaScript function, which will eventually call frequencyItem.notify():
+object to a JavaScript function, which will eventually call
+\c frequencyItem.notify():
\quotefromfile multimedia/video/qmlvideo/main.cpp
\skipto QGuiApplication
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
index af01e428..ca0a4af9 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
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp
index a11490ce..347198f6 100644
--- a/src/imports/audioengine/qdeclarative_sound_p.cpp
+++ b/src/imports/audioengine/qdeclarative_sound_p.cpp
@@ -61,7 +61,8 @@ QDeclarativeSoundCone::QDeclarativeSoundCone(QObject *parent)
\qmlproperty real Sound::cone.innerAngle
This property holds the innerAngle for Sound definition.
- The range is [0, 360] degree. There is no directional attenuation within innerAngle.
+ The range is [0, 360] degree. There is no directional attenuation
+ within innerAngle.
*/
qreal QDeclarativeSoundCone::innerAngle() const
{
@@ -88,8 +89,8 @@ void QDeclarativeSoundCone::setInnerAngle(qreal innerAngle)
\qmlproperty real Sound::cone.outerAngle
This property holds the outerAngle for Sound definition.
- The range is [0, 360] degree. All audio output from this sound will be attenuated by \l outerGain
- outside outerAngle.
+ The range is [0, 360] degree. All audio output from this sound will be
+ attenuated by \l {cone.outerGain}{outerGain} outside outerAngle.
*/
qreal QDeclarativeSoundCone::outerAngle() const
{
@@ -117,7 +118,7 @@ void QDeclarativeSoundCone::setOuterAngle(qreal outerAngle)
This property holds attenuation value for directional attenuation of this sound.
The range is [0, 1]. All audio output from this sound will be attenuated by outerGain
- outside \l outerAngle.
+ outside \l {cone.outerAngle}{outerAngle}.
*/
qreal QDeclarativeSoundCone::outerGain() const
{
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index 7f8c3323..ad748003 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -519,7 +519,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::stateChanged(state)
- This signal is emitted when \l state is changed
+ This signal is emitted when \a state is changed.
The corresponding handler is \c onStateChanged.
*/
@@ -527,7 +527,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::positionChanged()
- This signal is emitted when \l position is changed
+ This signal is emitted when \l position is changed.
The corresponding handler is \c onPositionChanged.
*/
@@ -535,7 +535,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::directionChanged()
- This signal is emitted when \l direction is changed
+ This signal is emitted when \l direction is changed.
The corresponding handler is \c onDirectionChanged.
*/
@@ -543,7 +543,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::velocityChanged()
- This signal is emitted when \l velocity is changed
+ This signal is emitted when \l velocity is changed.
The corresponding handler is \c onVelocityChanged.
*/
@@ -551,7 +551,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::gainChanged()
- This signal is emitted when \l gain is changed
+ This signal is emitted when \l gain is changed.
The corresponding handler is \c onGainChanged.
*/
@@ -559,7 +559,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::pitchChanged()
- This signal is emitted when \l pitch is changed
+ This signal is emitted when \l pitch is changed.
The corresponding handler is \c onPitchChanged.
*/
@@ -567,7 +567,7 @@ void QDeclarativeSoundInstance::handleStateChanged()
/*!
\qmlsignal QtAudioEngine::SoundInstance::soundChanged()
- This signal is emitted when \l sound is changed
+ This signal is emitted when \l sound is changed.
The corresponding handler is \c onSoundChanged.
*/
diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp
index 65606b3c..692aec2d 100644
--- a/src/imports/multimedia/qdeclarativeaudio.cpp
+++ b/src/imports/multimedia/qdeclarativeaudio.cpp
@@ -999,11 +999,13 @@ void QDeclarativeAudio::_q_mediaChanged(const QMediaContent &media)
/*!
\qmlsignal QtMultimedia::Audio::error(error, errorString)
- This signal is emitted when an \l {QMediaPlayer::Error}{error} has
- occurred. The errorString parameter may contain more detailed
+ This signal is emitted when an \a error has
+ occurred. The \a errorString parameter may contain more detailed
information about the error.
The corresponding handler is \c onError.
+
+ \sa QMediaPlayer::Error
*/
/*!
@@ -1531,11 +1533,13 @@ void QDeclarativeAudio::_q_mediaChanged(const QMediaContent &media)
/*!
\qmlsignal QtMultimedia::MediaPlayer::error(error, errorString)
- This signal is emitted when an \l {QMediaPlayer::Error}{error} has
- occurred. The errorString parameter may contain more detailed
+ This signal is emitted when an \a error has
+ occurred. The \a errorString parameter may contain more detailed
information about the error.
The corresponding handler is \c onError.
+
+ \sa QMediaPlayer::Error
*/
/*!
diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp
index c255f45d..63896c30 100644
--- a/src/imports/multimedia/qdeclarativecamera.cpp
+++ b/src/imports/multimedia/qdeclarativecamera.cpp
@@ -251,7 +251,7 @@ void QDeclarativeCamera::componentComplete()
preserved when changing the camera device.
\sa displayName, position
- \since QtMultimedia 5.4
+ \since 5.4
*/
QString QDeclarativeCamera::deviceId() const
@@ -292,7 +292,7 @@ void QDeclarativeCamera::setDeviceId(const QString &name)
preserved when changing the camera device.
\sa deviceId
- \since QtMultimedia 5.4
+ \since 5.4
*/
QDeclarativeCamera::Position QDeclarativeCamera::position() const
@@ -329,7 +329,7 @@ void QDeclarativeCamera::setPosition(Position position)
\readonly
\sa deviceId
- \since QtMultimedia 5.4
+ \since 5.4
*/
QString QDeclarativeCamera::displayName() const
@@ -353,7 +353,7 @@ QString QDeclarativeCamera::displayName() const
\readonly
\sa VideoOutput::orientation
- \since QtMultimedia 5.4
+ \since 5.4
*/
int QDeclarativeCamera::orientation() const
@@ -967,7 +967,7 @@ QDeclarativeCameraViewfinder *QDeclarativeCamera::viewfinder()
}
/*!
- \qmlmethod list<size> QtMultimedia::Camera::supportedViewfinderResolutions(real minimumFrameRate = undefined, real maximumFrameRate = undefined)
+ \qmlmethod list<size> QtMultimedia::Camera::supportedViewfinderResolutions(real minimumFrameRate, real maximumFrameRate)
Returns a list of supported viewfinder resolutions.
@@ -1003,7 +1003,7 @@ QJSValue QDeclarativeCamera::supportedViewfinderResolutions(qreal minimumFrameRa
}
/*!
- \qmlmethod list<object> QtMultimedia::Camera::supportedViewfinderFrameRateRanges(size resolution = undefined)
+ \qmlmethod list<object> QtMultimedia::Camera::supportedViewfinderFrameRateRanges(size resolution)
Returns a list of supported viewfinder frame rate ranges.
diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp
index 551b88ae..5ce4a5d0 100644
--- a/src/imports/multimedia/qdeclarativecameraflash.cpp
+++ b/src/imports/multimedia/qdeclarativecameraflash.cpp
@@ -181,13 +181,13 @@ QVariantList QDeclarativeCameraFlash::supportedModes() const
}
/*!
- \qmlsignal QtMultimedia::CameraFlash::flashModeChanged(int)
+ \qmlsignal QtMultimedia::CameraFlash::flashModeChanged()
This signal is emitted when the \c flashMode property is changed.
The corresponding handler is \c onFlashModeChanged.
*/
/*!
- \qmlsignal QtMultimedia::CameraFlash::flashReady(bool)
+ \qmlsignal QtMultimedia::CameraFlash::flashReady()
This signal is emitted when QCameraExposure indicates that
the flash is ready to use.
The corresponding handler is \c onFlashReadyChanged.
diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
index 8e14a794..908afea2 100644
--- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
+++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
@@ -343,14 +343,14 @@ void QDeclarativeCameraImageProcessing::setColorFilter(ColorFilter filter)
}
/*!
- \qmlsignal QtMultimedia::Camera::whiteBalanceModeChanged(Camera::WhiteBalanceMode)
+ \qmlsignal QtMultimedia::Camera::whiteBalanceModeChanged()
This signal is emitted when the \c whiteBalanceMode property is changed.
The corresponding handler is \c onWhiteBalanceModeChanged.
*/
/*!
- \qmlsignal QtMultimedia::Camera::manualWhiteBalanceChanged(qreal)
+ \qmlsignal QtMultimedia::Camera::manualWhiteBalanceChanged()
This signal is emitted when the \c manualWhiteBalance property is changed.
The corresponding handler is \c onManualWhiteBalanceChanged.
diff --git a/src/imports/multimedia/qdeclarativemultimediaglobal.cpp b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp
index 999f086d..ac7a6496 100644
--- a/src/imports/multimedia/qdeclarativemultimediaglobal.cpp
+++ b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\qmltype QtMultimedia
\inqmlmodule QtMultimedia
\ingroup multimedia_qml
-\since QtMultimedia 5.4
+\since 5.4
\brief Provides a global object with useful functions from Qt Multimedia.
The \c QtMultimedia object is a global object with utility functions and properties.
diff --git a/src/imports/multimedia/qdeclarativeplaylist.cpp b/src/imports/multimedia/qdeclarativeplaylist.cpp
index 549e0702..b768f99e 100644
--- a/src/imports/multimedia/qdeclarativeplaylist.cpp
+++ b/src/imports/multimedia/qdeclarativeplaylist.cpp
@@ -486,7 +486,7 @@ bool QDeclarativePlaylist::insertItems(int index, const QList<QUrl> &sources)
Moves the item at index position \a from to index position \a to.
- Returns true if the item is moved successfully.
+ Returns \c true if the item is moved successfully.
\since 5.7
*/
@@ -498,9 +498,9 @@ bool QDeclarativePlaylist::moveItem(int from, int to)
/*!
\qmlmethod bool QtMultimedia::Playlist::removeItem(index)
- Removed the item at the given \a index from the playlist.
+ Removes the item at the given \a index from the playlist.
- Returns true if the \a source is removed successfully.
+ Returns \c true if the item is removed successfully.
*/
bool QDeclarativePlaylist::removeItem(int index)
{
@@ -512,7 +512,7 @@ bool QDeclarativePlaylist::removeItem(int index)
Removes items in the playlist from \a start to \a end inclusive.
- Returns true if the items are removed successfully.
+ Returns \c true if the items are removed successfully.
\since 5.7
*/
@@ -526,7 +526,7 @@ bool QDeclarativePlaylist::removeItems(int start, int end)
Removes all the items from the playlist.
- Returns true if the operation is successful.
+ Returns \c true if the operation is successful.
*/
bool QDeclarativePlaylist::clear()
{
diff --git a/src/imports/multimedia/qdeclarativeradio.cpp b/src/imports/multimedia/qdeclarativeradio.cpp
index ec2d943e..f92ddd91 100644
--- a/src/imports/multimedia/qdeclarativeradio.cpp
+++ b/src/imports/multimedia/qdeclarativeradio.cpp
@@ -393,7 +393,7 @@ void QDeclarativeRadio::scanUp()
\qmlmethod QtMultimedia::Radio::searchAllStations(enumeration searchMode)
Start searching the complete frequency range for the current band, and save all the
- radio stations found. The search mode can be either of the values described in the
+ radio stations found. The \a searchMode can be either of the values described in the
table below.
\table
diff --git a/src/multimedia/audio/qaudiobuffer.cpp b/src/multimedia/audio/qaudiobuffer.cpp
index f3e7ae67..1e43ebd0 100644
--- a/src/multimedia/audio/qaudiobuffer.cpp
+++ b/src/multimedia/audio/qaudiobuffer.cpp
@@ -573,35 +573,30 @@ void *QAudioBuffer::data()
/*!
\typedef QAudioBuffer::S8U
- \relates QAudioBuffer::StereoFrame
This is a predefined specialization for an unsigned stereo 8 bit sample. Each
channel is an \e {unsigned char}.
*/
/*!
\typedef QAudioBuffer::S8S
- \relates QAudioBuffer::StereoFrame
This is a predefined specialization for a signed stereo 8 bit sample. Each
channel is a \e {signed char}.
*/
/*!
\typedef QAudioBuffer::S16U
- \relates QAudioBuffer::StereoFrame
This is a predefined specialization for an unsigned stereo 16 bit sample. Each
channel is an \e {unsigned short}.
*/
/*!
\typedef QAudioBuffer::S16S
- \relates QAudioBuffer::StereoFrame
This is a predefined specialization for a signed stereo 16 bit sample. Each
channel is a \e {signed short}.
*/
/*!
\typedef QAudioBuffer::S32F
- \relates QAudioBuffer::StereoFrame
This is a predefined specialization for an 32 bit float sample. Each
channel is a \e float.
diff --git a/src/multimedia/doc/QtMultimediaDoc b/src/multimedia/doc/QtMultimediaDoc
index 5723c2a7..e57c3595 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 b547db76..256ad261 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 bf8be899..c45d4e8a 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 aec3d99d..a2aaa1a8 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
*/
diff --git a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp
index b6d3afaa..4ef605e2 100644
--- a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp
+++ b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp
@@ -511,7 +511,7 @@ void QDeclarativeVideoOutput::setOrientation(int orientation)
By default \c autoOrientation is disabled.
\sa orientation
- \since QtMultimedia 5.2
+ \since 5.2
*/
bool QDeclarativeVideoOutput::autoOrientation() const
{
@@ -880,7 +880,7 @@ void QDeclarativeVideoOutput::_q_invalidateSceneGraph()
/*!
\qmlproperty enumeration QtMultimedia::VideoOutput::flushMode
- \since QtMultimedia 5.13
+ \since 5.13
Set this property to define what \c VideoOutput should show
when playback is finished or stopped.