summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-09-09 14:56:54 +0200
committerTopi Reinio <topi.reinio@qt.io>2021-09-24 05:26:15 +0200
commit2cf23496f347c35ad32d37d8151998d12e26278d (patch)
tree3fc76fb39ade2a2f09808d3b2d4f57398139d379
parentfaa56ec161889926dba78447ec1b5288fb0ab7a5 (diff)
Doc: Fix various documentation issues
* Fix linking issues * Document all QMediaFormat::AudioCodec enum values * Fix example \quotefromfile paths * Document QMediaFormat::ResolveFlags * Drop links to removed classes/functions Fixes: QTBUG-96340 Change-Id: Iae82295e9cd396b392af2e577b21158ad1509fd3 Reviewed-by: Lars Knoll <lars.knoll@qt.io> (cherry picked from commit e22ddea9d62d84a4b28b2395d4f259dd1d4b1094)
-rw-r--r--examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc8
-rw-r--r--examples/multimediawidgets/camera/doc/src/camera.qdoc11
-rw-r--r--src/multimedia/camera/qimagecapture.cpp4
-rw-r--r--src/multimedia/doc/qtmultimedia.qdocconf2
-rw-r--r--src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc6
-rw-r--r--src/multimedia/doc/src/qm-external-pages.qdoc15
-rw-r--r--src/multimedia/platform/qplatformaudiodecoder.cpp5
-rw-r--r--src/multimedia/platform/qplatformmediaencoder.cpp2
-rw-r--r--src/multimedia/qmediametadata.cpp3
-rw-r--r--src/multimedia/recording/qmediarecorder.cpp2
10 files changed, 32 insertions, 26 deletions
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
index 89dc717e6..c96066687 100644
--- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
+++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
@@ -76,11 +76,9 @@
will have the text "Resume".
Pressing the buttons will also result in a toggle based on the state. If
- recording is stopped, then pressing the record button will setup the
- \l{QAudioEncoderSettings} based on the values of the selection lists,
- will set the encoding settings and container on the \c audioRecorder
- object, and start recording using the
- \l{QMediaRecorder::record()}{record()} method.
+ recording is stopped, then pressing the record button will set the encoding
+ settings and container on the \c audioRecorder object, and start recording
+ using the \l{QMediaRecorder::record()}{record()} method.
\code
QMediaFormat format;
diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc
index 99d626ee6..4db430fc3 100644
--- a/examples/multimediawidgets/camera/doc/src/camera.qdoc
+++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc
@@ -72,13 +72,10 @@ object is called.
Now that the camera is ready for user commands it waits for a suitable event.
Such an event can be a key press of either the \l {Qt::Key_CameraFocus} or
\l {Qt::Key_Camera} buttons on the application window. Camera focus will
-simply display the preview and lock the camera settings. Key_Camera will
-either call \e{takeImage()} if capturing still images, or if the capture mode
-is for video then one
-of two actions will occur. If the recording state shows that we are currently
-recording then the \e{stop()} function is called resulting in a call to
-\l {QCamera::stop()}, whereas if we are not recording then a video recording
-is started with a call to \l {QMediaRecorder::record()}.
+simply display the preview and lock the camera settings. \c Key_Camera will
+either call \e{takeImage()} if doing an image capture, or call
+\c record() or \c stop() (if already recording) on the QMediaRecorder instance
+when recording video.
\image camera-example.png
diff --git a/src/multimedia/camera/qimagecapture.cpp b/src/multimedia/camera/qimagecapture.cpp
index eedb7ecbb..7b8473c7a 100644
--- a/src/multimedia/camera/qimagecapture.cpp
+++ b/src/multimedia/camera/qimagecapture.cpp
@@ -244,7 +244,9 @@ void QImageCapture::addMetaData(const QMediaMetaData &metaData)
}
/*!
- Returns true if the camera is ready to capture an image immediately.
+ \property QImageCapture::readyForCapture
+
+ Holds \c true if the camera is ready to capture an image immediately.
Calling capture() while \c readyForCapture is \c false is not
permitted and results in an error.
*/
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf
index 49aec6512..35319b0b4 100644
--- a/src/multimedia/doc/qtmultimedia.qdocconf
+++ b/src/multimedia/doc/qtmultimedia.qdocconf
@@ -61,7 +61,7 @@ sourcedirs += ../..
excludedirs += ../../gsttools
-depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork
+depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork qmake qtcmake
# Ignore \since commands for versions earlier than 6.3
ignoresince = 6.3
diff --git a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
index 533bdf37f..f531e613a 100644
--- a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
+++ b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
@@ -24,8 +24,8 @@ The FrequencyMonitor class is exposed to QML like this
\printuntil }
and its data is displayed by defining a QML item called FrequencyItem, like this:
-qmlvideo\qml\frequencymonitor
-\quotefromfile multimedia/video/qmlvideo/frequencymonitor/qml/frequencymonitor/FrequencyItem.qml
+
+\quotefromfile multimedia/video/qmlvideo/qml/frequencymonitor/FrequencyItem.qml
\skipto import FrequencyMonitor
\printuntil id: root
\dots
@@ -39,5 +39,3 @@ qmlvideo\qml\frequencymonitor
The result looks like this:
\image video-qml-paint-rate.png
-
-
diff --git a/src/multimedia/doc/src/qm-external-pages.qdoc b/src/multimedia/doc/src/qm-external-pages.qdoc
index 5f0f45629..97964b059 100644
--- a/src/multimedia/doc/src/qm-external-pages.qdoc
+++ b/src/multimedia/doc/src/qm-external-pages.qdoc
@@ -112,6 +112,11 @@
*/
/*!
+ \externalpage https://en.wikipedia.org/wiki/ALAC
+ \title Apple Lossless Audio Codec
+*/
+
+/*!
\externalpage https://en.wikipedia.org/wiki/Matroska
\title Matroska (MKV)
*/
@@ -172,6 +177,16 @@
*/
/*!
+ \externalpage https://en.wikipedia.org/wiki/Dolby_Digital_Plus
+ \title Dolby Digital Plus (EAC3)
+*/
+
+/*!
+ \externalpage https://en.wikipedia.org/wiki/Opus_(audio_format)
+ \title Opus Audio Format
+*/
+
+/*!
\externalpage https://en.wikipedia.org/wiki/Dolby_TrueHD
\title Dolby TrueHD
*/
diff --git a/src/multimedia/platform/qplatformaudiodecoder.cpp b/src/multimedia/platform/qplatformaudiodecoder.cpp
index 82c769f31..c5c1ca667 100644
--- a/src/multimedia/platform/qplatformaudiodecoder.cpp
+++ b/src/multimedia/platform/qplatformaudiodecoder.cpp
@@ -109,8 +109,7 @@ QPlatformAudioDecoder::QPlatformAudioDecoder(QAudioDecoder *parent)
Stops playback of the current media and discards any buffers.
- If successful the player control will immediately enter the \l {QAudioDecoder::StoppedState}
- {stopped} state.
+ If successful, the player control will immediately stop decoding.
*/
/*!
@@ -172,8 +171,6 @@ void QPlatformAudioDecoder::sourceChanged()
\fn QPlatformAudioDecoder::formatChanged(const QAudioFormat &format)
Signals that the current audio format of the decoder has changed to \a format.
-
- \sa audioFormat(), setAudioFormat()
*/
void QPlatformAudioDecoder::formatChanged(const QAudioFormat &format)
{
diff --git a/src/multimedia/platform/qplatformmediaencoder.cpp b/src/multimedia/platform/qplatformmediaencoder.cpp
index f25fa098f..cc723ab3b 100644
--- a/src/multimedia/platform/qplatformmediaencoder.cpp
+++ b/src/multimedia/platform/qplatformmediaencoder.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
functionality.
This control provides a means to set the \l {outputLocation()}{output location},
- and record, pause and stop recording via the \l setState() method. It also
+ and record(), pause(), resume(), and stop() recording. It also
provides feedback on the \l {duration()}{duration} of the recording.
\sa QMediaRecorder
diff --git a/src/multimedia/qmediametadata.cpp b/src/multimedia/qmediametadata.cpp
index 85daa9a36..7f9492adf 100644
--- a/src/multimedia/qmediametadata.cpp
+++ b/src/multimedia/qmediametadata.cpp
@@ -417,13 +417,12 @@ QString QMediaMetaData::metaDataKeyToString(QMediaMetaData::Key key)
// operator documentation
/*!
\fn QVariant &QMediaMetaData ::operator[](QMediaMetaData::Key k)
- The \c [] operator returns data stored at the Key \a{k}.
+ Returns data stored at the Key \a{k}.
\code
QMediaMetaData rockBallad1;
rockBalad[QMediaMetaData::Genre]="Rock"
\endcode
*/
-
/*!
\fn bool QMediaMetaData::operator==(const QMediaMetaData &a, const QMediaMetaData &b)
Compares two meta data objects \a a and \a b, and returns
diff --git a/src/multimedia/recording/qmediarecorder.cpp b/src/multimedia/recording/qmediarecorder.cpp
index 36d8a2f86..02ec2a4a1 100644
--- a/src/multimedia/recording/qmediarecorder.cpp
+++ b/src/multimedia/recording/qmediarecorder.cpp
@@ -192,7 +192,7 @@ void QMediaRecorder::setCaptureSession(QMediaCaptureSession *session)
The location can be relative or empty. If empty the recorder uses the
system specific place and file naming scheme.
- \sa errorOccured()
+ \sa errorOccurred()
*/
/*!