summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@qt.io>2021-09-22 15:08:25 +0200
committerLars Knoll <lars.knoll@qt.io>2021-09-23 12:12:50 +0200
commit671161e78a38b679096da2ddbbf11effd2b69905 (patch)
tree84dd85b0ca7ddb3ae1326b07bc3e24fe69347c53
parentaf3d023be819bad923873fc048beacb743ff5d8f (diff)
downloadqtmultimedia-671161e78a38b679096da2ddbbf11effd2b69905.tar.gz
Fix the remaining qdoc warnings
Fix all qdoc warnings inside the Qt Multimedia module. Change-Id: I4a581aa4f9fa9d96d58279884116ed10ca7bf837 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit baa34e18560d816c82d8779fbb40b1911ee0e164) Reviewed-by: Lars Knoll <lars.knoll@qt.io>
-rw-r--r--examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc4
-rw-r--r--examples/multimediawidgets/camera/doc/src/camera.qdoc6
-rw-r--r--src/multimedia/audio/qaudio.cpp8
-rw-r--r--src/multimedia/audio/qaudiodevice.cpp2
-rw-r--r--src/multimedia/audio/qaudioinput.cpp2
-rw-r--r--src/multimedia/audio/qaudiooutput.cpp2
-rw-r--r--src/multimedia/camera/qcamera.cpp73
-rw-r--r--src/multimedia/camera/qcamera.h2
-rw-r--r--src/multimedia/camera/qcameradevice.cpp14
-rw-r--r--src/multimedia/doc/src/cameraoverview.qdoc11
-rw-r--r--src/multimedia/doc/src/multimedia-overview.qdoc2
-rw-r--r--src/multimedia/platform/qplatformaudiodecoder.cpp2
-rw-r--r--src/multimedia/platform/qplatformimagecapture.cpp2
-rw-r--r--src/multimedia/platform/qplatformmediaencoder.cpp2
-rw-r--r--src/multimedia/platform/qplatformvideosink.cpp3
-rw-r--r--src/multimedia/playback/qmediaplayer.cpp46
-rw-r--r--src/multimedia/qmediaformat.cpp23
-rw-r--r--src/multimedia/qmediametadata.cpp16
-rw-r--r--src/multimedia/recording/qmediacapturesession.cpp15
-rw-r--r--src/multimedia/recording/qmediacapturesession.h2
-rw-r--r--src/multimedia/recording/qmediarecorder.cpp2
-rw-r--r--src/multimedia/video/qvideoframeformat.cpp4
-rw-r--r--src/multimedia/video/qvideosink.cpp4
-rw-r--r--src/multimedia/video/qvideowindow.cpp1
-rw-r--r--src/multimediaquick/qquickimagecapture.cpp5
-rw-r--r--src/multimediaquick/qquickvideooutput.cpp2
26 files changed, 118 insertions, 137 deletions
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
index b8e14508e..89dc717e6 100644
--- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
+++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
@@ -49,8 +49,8 @@
The lists are populated using the following methods:
\list
\li \l{QMediaDevices::audioInputs()}
- \li \l{QMediaFormat::supportedAudioCodecs()}
- \li \l{QMediaFormat::supportedFileFormats()}
+ \li \l{QMediaFormat::supportedAudioCodecs}
+ \li \l{QMediaFormat::supportedFileFormats}
\li \l{QAudioDevice::maximumSampleRate()}
\li \l{QAudioDevice::minimumSampleRate()}
\endlist
diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc
index 1378e1e87..99d626ee6 100644
--- a/examples/multimediawidgets/camera/doc/src/camera.qdoc
+++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc
@@ -66,15 +66,15 @@ passing in a \l QCameraDevice.
functionality of the Camera class using signals and slots. It also instantiates
and initializes the \l {QCamera}, \l {QImageCapture}, and \l {QMediaRecorder}
objects mentioned above. The still and video recording visual tabs are enabled
-and finally the \l {QCamera::start()}{start()} function of the \l{QCamera}
+and finally the \l {QCamera::start}{start()} function of the \l{QCamera}
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 the \l {QCamera::captureMode()}{captureMode()}
-is QCamera::CaptureStillImage, or if the capture mode is for video then one
+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
diff --git a/src/multimedia/audio/qaudio.cpp b/src/multimedia/audio/qaudio.cpp
index f38ff0628..2898868a9 100644
--- a/src/multimedia/audio/qaudio.cpp
+++ b/src/multimedia/audio/qaudio.cpp
@@ -80,14 +80,6 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \enum QAudioDevice::Mode
-
- \value Output Audio output device
- \value Input Audio input device
- \omitvalue Null
-*/
-
-/*!
\enum QAudio::VolumeScale
This enum defines the different audio volume scales.
diff --git a/src/multimedia/audio/qaudiodevice.cpp b/src/multimedia/audio/qaudiodevice.cpp
index 9eebbbfe3..5a9f20e64 100644
--- a/src/multimedia/audio/qaudiodevice.cpp
+++ b/src/multimedia/audio/qaudiodevice.cpp
@@ -324,7 +324,7 @@ QAudioDevice::QAudioDevice(QAudioDevicePrivate *p)
{}
/*!
- \enum QAudioDevice::mode
+ \enum QAudioDevice::Mode
Describes the mode of a QAudioDevice
diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp
index ead7c3b07..1d0d68f0f 100644
--- a/src/multimedia/audio/qaudioinput.cpp
+++ b/src/multimedia/audio/qaudioinput.cpp
@@ -159,7 +159,7 @@ void QAudioInput::setMuted(bool muted)
}
/*!
- \qmlproperty QtMultimedia::AudioInput::device
+ \qmlproperty AudioDevice QtMultimedia::AudioInput::device
This property describes the audio device connected to this input.
diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp
index ea3bb28bf..275050a51 100644
--- a/src/multimedia/audio/qaudiooutput.cpp
+++ b/src/multimedia/audio/qaudiooutput.cpp
@@ -183,7 +183,7 @@ void QAudioOutput::setMuted(bool muted)
}
/*!
- \qmlproperty QtMultimedia::AudioOutput::device
+ \qmlproperty AudioDevice QtMultimedia::AudioOutput::device
This property describes the audio device connected to this output.
diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index 7094f169d..b866441c1 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -303,7 +303,7 @@ bool QCamera::isAvailable() const
Describes whether the camera is currently active.
*/
-/*! \property bool QCamera::active
+/*! \property QCamera::active
Describes whether the camera is currently active.
*/
@@ -358,7 +358,7 @@ QString QCamera::errorString() const
return d_func()->errorString;
}
-/*! \enum QCamera::Features
+/*! \enum QCamera::Feature
Describes a set of features supported by the camera. The returned value can be a
combination of:
@@ -370,9 +370,9 @@ QString QCamera::errorString() const
\value IsoSensitivity
The Camera supports setting a custom \l{isoSensitivity}.
\value ManualExposureTime
- The Camera supports setting a \l{manual exposure Time}{QCamera::manualExposureTime}.
+ The Camera supports setting a \l{QCamera::manualExposureTime}{manual exposure Time}.
\value CustomFocusPoint
- The Camera supports setting a \l{custom focus point}{QCamera::customFocusPoint}.
+ The Camera supports setting a \l{QCamera::customFocusPoint}{custom focus point}.
\value FocusDistance
The Camera supports setting the \l{focusDistance} property.
*/
@@ -381,13 +381,13 @@ QString QCamera::errorString() const
\qmlproperty Features QtMultimedia::Camera::supportedFeatures
Returns the features supported by this camera.
- \sa QCamera::Features
+ \sa QCamera::Feature
*/
/*!
Returns the features supported by this camera.
- \sa QCamera::Features
+ \sa QCamera::Feature
*/
QCamera::Features QCamera::supportedFeatures() const
{
@@ -399,7 +399,7 @@ QCamera::Features QCamera::supportedFeatures() const
Starts the camera.
- Same as setActive(true).
+ Same as setting the active property to true.
If the camera can't be started for some reason, the errorOccurred() signal is emitted.
*/
@@ -416,7 +416,7 @@ QCamera::Features QCamera::supportedFeatures() const
/*! \qmlmethod void Camera::stop()
Stops the camera.
- Same as setActive(false).
+ Same as setting the active property to false.
*/
/*! \fn void QCamera::stop()
@@ -472,8 +472,9 @@ QCameraDevice QCamera::cameraDevice() const
}
/*!
- Sets the camera object to use the physical camera described by
- \a cameraDevice.
+ Connects the camera object to the physical camera device described by
+ \a cameraDevice. Using a default constructed QCameraDevice object as
+ \a cameraDevice will connect the camera to the system default camera device.
*/
void QCamera::setCameraDevice(const QCameraDevice &cameraDevice)
{
@@ -567,7 +568,7 @@ void QCamera::setCameraFormat(const QCameraFormat &format)
If a certain focus mode is not supported, setting it will have no effect.
- \sa isFocusModeSupported()
+ \sa isFocusModeSupported
*/
/*!
@@ -578,7 +579,7 @@ void QCamera::setCameraFormat(const QCameraFormat &format)
Locking the focus is possible by setting the focus mode to \l FocusModeManual. This will keep
the current focus and stop any automatic focusing.
- \sa QCamera::isFocusModeSupported()
+ \sa isFocusModeSupported
*/
QCamera::FocusMode QCamera::focusMode() const
{
@@ -596,7 +597,7 @@ void QCamera::setFocusMode(QCamera::FocusMode mode)
}
/*!
- \qmlproperty bool Camera::isFocusModeSupported(FocusMode mode)
+ \qmlmethod bool Camera::isFocusModeSupported(FocusMode mode)
Returns true if the focus \a mode is supported by the camera.
*/
@@ -611,6 +612,11 @@ bool QCamera::isFocusModeSupported(FocusMode mode) const
}
/*!
+ \qmlproperty point QtMultimedia::Camera::focusPoint
+ Returns the point currently used by the auto focus system to focus onto.
+*/
+
+/*!
Returns the point currently used by the auto focus system to focus onto.
*/
QPointF QCamera::focusPoint() const
@@ -735,7 +741,7 @@ float QCamera::minimumZoomFactor() const
}
/*!
- \qmlproperty QCamera::zoomFactor
+ \qmlproperty real QtMultimedia::Camera::zoomFactor
Gets or sets the current zoom factor. Values will be clamped between
\l minimumZoomFactor and \l maximumZoomFactor.
@@ -813,7 +819,7 @@ void QCamera::zoomTo(float factor, float rate)
Gets or sets a certain flash mode if the camera has a flash.
- \sa QCamera::FlashMode, Camera::isFlashModeSupported(), Camera::isFlashReady()
+ \sa QCamera::FlashMode, Camera::isFlashModeSupported, Camera::isFlashReady
*/
/*!
@@ -822,7 +828,7 @@ void QCamera::zoomTo(float factor, float rate)
Enables a certain flash mode if the camera has a flash.
- \sa QCamera::FlashMode, QCamera::isFlashModeSupported(), QCamera::isFlashReady()
+ \sa QCamera::FlashMode, QCamera::isFlashModeSupported, QCamera::isFlashReady
*/
QCamera::FlashMode QCamera::flashMode() const
{
@@ -838,7 +844,7 @@ void QCamera::setFlashMode(QCamera::FlashMode mode)
}
/*!
- \qmlmethod QtMultimedia::Camera::isFlashModeSupported(FlashMode mode)
+ \qmlmethod bool QtMultimedia::Camera::isFlashModeSupported(FlashMode mode)
Returns true if the flash \a mode is supported.
*/
@@ -887,7 +893,7 @@ bool QCamera::isFlashReady() const
low light conditions. Enabling torch mode will usually override any currently set
flash mode.
- \sa QCamera::TorchMode, QCamera::isTorchModeSupported(), QCamera::flashMode
+ \sa QCamera::TorchMode, QCamera::isTorchModeSupported, QCamera::flashMode
*/
QCamera::TorchMode QCamera::torchMode() const
{
@@ -928,7 +934,7 @@ bool QCamera::isTorchModeSupported(QCamera::TorchMode mode) const
\property QCamera::exposureMode
\brief The exposure mode being used.
- \sa QCamera::isExposureModeSupported()
+ \sa QCamera::isExposureModeSupported
*/
QCamera::ExposureMode QCamera::exposureMode() const
{
@@ -944,7 +950,7 @@ void QCamera::setExposureMode(QCamera::ExposureMode mode)
}
/*!
- \qmlmethod bool QtMultimedia::Camera::isTorchModeSupported(ExposureMode mode)
+ \qmlmethod bool QtMultimedia::Camera::isExposureModeSupported(ExposureMode mode)
Returns true if the exposure \a mode is supported.
*/
@@ -962,7 +968,7 @@ bool QCamera::isExposureModeSupported(QCamera::ExposureMode mode) const
}
/*!
- \qmlproperty QCamera::exposureCompensation
+ \qmlproperty real QCamera::exposureCompensation
Gets or sets the exposure compensation in EV units.
@@ -998,8 +1004,12 @@ void QCamera::setExposureCompensation(float ev)
*/
/*!
- \property int QCamera::manualIsoSensitivity
- \brief Describes the ISO sensitivity currently used by the camera.
+ \property QCamera::isoSensitivity
+ \brief The sensor ISO sensitivity.
+
+ Describes the ISO sensitivity currently used by the camera.
+
+ \sa setAutoIsoSensitivity(), setManualIsoSensitivity()
*/
int QCamera::isoSensitivity() const
{
@@ -1017,7 +1027,7 @@ int QCamera::isoSensitivity() const
*/
/*!
- \property int QCamera::manualIsoSensitivity
+ \property QCamera::manualIsoSensitivity
\brief Describes a manually set ISO sensitivity
Setting this property to -1 (the default), implies that the camera
@@ -1107,13 +1117,6 @@ float QCamera::maximumExposureTime() const
*/
/*!
- \property QCamera::isoSensitivity
- \brief The sensor ISO sensitivity.
-
- \sa setAutoIsoSensitivity(), setManualIsoSensitivity()
-*/
-
-/*!
Returns the current exposure time in seconds.
*/
@@ -1124,7 +1127,7 @@ float QCamera::exposureTime() const
}
/*!
- \qmlproperty QtMultimedia::Camera::manualExposureTime
+ \qmlproperty real QtMultimedia::Camera::manualExposureTime
Gets or sets a manual exposure time.
@@ -1203,7 +1206,7 @@ void QCamera::setAutoExposureTime()
*/
/*!
- \qmlproperty QtMultimedia::Camera::flashReady
+ \qmlproperty bool QtMultimedia::Camera::flashReady
Indicates if the flash is charged and ready to use.
*/
@@ -1233,9 +1236,11 @@ void QCamera::setAutoExposureTime()
/*!
- \qmlproperty QtMultimedia::Camera::whiteBalanceMode
+ \qmlproperty WhiteBalanceMode QtMultimedia::Camera::whiteBalanceMode
Gets or sets the white balance mode being used.
+
+ \sa QCamera::WhiteBalanceMode
*/
/*!
diff --git a/src/multimedia/camera/qcamera.h b/src/multimedia/camera/qcamera.h
index 9bbbf453c..f9f107ec3 100644
--- a/src/multimedia/camera/qcamera.h
+++ b/src/multimedia/camera/qcamera.h
@@ -70,6 +70,7 @@ class Q_MULTIMEDIA_EXPORT QCamera : public QObject
Q_PROPERTY(QCameraFormat cameraFormat READ cameraFormat WRITE setCameraFormat NOTIFY cameraFormatChanged)
Q_PROPERTY(FocusMode focusMode READ focusMode WRITE setFocusMode)
+ Q_PROPERTY(QPointF focusPoint READ focusPoint NOTIFY focusPointChanged)
Q_PROPERTY(QPointF customFocusPoint READ customFocusPoint WRITE setCustomFocusPoint NOTIFY customFocusPointChanged)
Q_PROPERTY(float focusDistance READ focusDistance WRITE setFocusDistance NOTIFY focusDistanceChanged)
@@ -268,6 +269,7 @@ Q_SIGNALS:
void minimumZoomFactorChanged(float);
void maximumZoomFactorChanged(float);
void focusDistanceChanged(float);
+ void focusPointChanged();
void customFocusPointChanged();
void flashReady(bool);
diff --git a/src/multimedia/camera/qcameradevice.cpp b/src/multimedia/camera/qcameradevice.cpp
index 096ee314d..befd78af2 100644
--- a/src/multimedia/camera/qcameradevice.cpp
+++ b/src/multimedia/camera/qcameradevice.cpp
@@ -43,7 +43,6 @@
QT_BEGIN_NAMESPACE
-
/*!
\class QCameraFormat
\since 6.2
@@ -73,16 +72,16 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia_qml
\ingroup multimedia_video_qml
- CameraFormat represents a certain video format supported by a camera device.
+ cameraFormat represents a certain video format supported by a camera device.
The format is a combination of a
\l{pixel format}{QVideoFrameFormat::PixelFormat}, resolution and a range of frame
rates.
- CameraFormat objects can be queried from \l CameraDevice to inspect the set of
+ cameraFormat objects can be queried from \l cameraDevice to inspect the set of
supported video formats.
- \sa CameraDevice, Camera
+ \sa cameraDevice, Camera
*/
/*!
@@ -107,6 +106,11 @@ QCameraFormat &QCameraFormat::operator=(const QCameraFormat &other) noexcept = d
*/
QCameraFormat::~QCameraFormat() = default;
+/*! \fn bool QCameraFormat::isNull() const noexcept
+
+ Returns true if this is a default constructed QCameraFormat.
+*/
+
/*!
\qmlproperty enumeration QtMultimedia::CameraFormat::pixelFormat
@@ -402,7 +406,7 @@ QCameraDevice::Position QCameraDevice::position() const
Returns a list of resolutions that the camera can use to
capture still images.
- \sa QCameraImageCapture
+ \sa QImageCapture
*/
QList<QSize> QCameraDevice::photoResolutions() const
{
diff --git a/src/multimedia/doc/src/cameraoverview.qdoc b/src/multimedia/doc/src/cameraoverview.qdoc
index c5f9048ff..8753d86e0 100644
--- a/src/multimedia/doc/src/cameraoverview.qdoc
+++ b/src/multimedia/doc/src/cameraoverview.qdoc
@@ -217,7 +217,7 @@ Thus, as the user rotates the device, the preview image will switch between port
landscape mode. Once you start recording, the orientation will be locked. To avoid a poor
user experience, you should also lock the orientation of the applications user interface
while recording. This can be achieved using the
-\l{contentOrientation}{QWindow::contentOrientation} property of QWindow.
+\l{QWindow::contentOrientation}{contentOrientation} property of QWindow.
\section2 Still Images
@@ -261,11 +261,12 @@ For camera hardware that supports it, \l QCamera::FocusModeAutoNear allows
imaging of things that are close to the sensor. This is useful in applications
like bar-code recognition, or business card scanning.
-In addition to focus, QCameraFocus allows you to control any available zoom
-functionality using \l QCamera::setZoomFactor() or \l QCamera::zoomTo(). The
+In addition to focus, QCamera allows you to control any available zoom
+functionality using \l{QCamera::setZoomFactor}{setZoomFactor()} or
+\l{QCamera::zoomTo}{zoomTo()}. The
available zoom range might be limited or entirely fixed to unity (1:1). The
-allowed range can be checked with \l QCamera::minimumZoomFactor() and
-\l QCamera::minimumZoomFactor().
+allowed range can be checked with \l{QCamera::minimumZoomFactor}{minimumZoomFactor()}
+and \l{QCamera::maximumZoomFactor}{maximumZoomFactor()}.
\section3 Exposure, Shutter Speed and Flash
diff --git a/src/multimedia/doc/src/multimedia-overview.qdoc b/src/multimedia/doc/src/multimedia-overview.qdoc
index 84a7c2b69..bebb59ca1 100644
--- a/src/multimedia/doc/src/multimedia-overview.qdoc
+++ b/src/multimedia/doc/src/multimedia-overview.qdoc
@@ -114,7 +114,7 @@ For some quick recipes, see this table:
\row
\li Discovering audio and video devices
\li \l{Audio Devices Example}{audiodevices}
- \li \l{MediaDevices}, \l{AudioDevice}, \l{CameraDevice}
+ \li \l{MediaDevices}, \l{audioDevice}, \l{cameraDevice}
\li QMediaDevices, QAudioDevice, QCameraDevice
\row
\li Video Playback
diff --git a/src/multimedia/platform/qplatformaudiodecoder.cpp b/src/multimedia/platform/qplatformaudiodecoder.cpp
index 76b376078..82c769f31 100644
--- a/src/multimedia/platform/qplatformaudiodecoder.cpp
+++ b/src/multimedia/platform/qplatformaudiodecoder.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QPlatformAudioDecoder
- \obsolete
+ \internal
\inmodule QtMultimedia
diff --git a/src/multimedia/platform/qplatformimagecapture.cpp b/src/multimedia/platform/qplatformimagecapture.cpp
index 5cfc7e31e..3de5c3abf 100644
--- a/src/multimedia/platform/qplatformimagecapture.cpp
+++ b/src/multimedia/platform/qplatformimagecapture.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QPlatformImageCapture
- \obsolete
+ \internal
\brief The QPlatformImageCapture class provides a control interface
for image capture services.
diff --git a/src/multimedia/platform/qplatformmediaencoder.cpp b/src/multimedia/platform/qplatformmediaencoder.cpp
index a4001b762..f25fa098f 100644
--- a/src/multimedia/platform/qplatformmediaencoder.cpp
+++ b/src/multimedia/platform/qplatformmediaencoder.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QPlatformMediaEncoder
- \obsolete
+ \internal
\inmodule QtMultimedia
diff --git a/src/multimedia/platform/qplatformvideosink.cpp b/src/multimedia/platform/qplatformvideosink.cpp
index d3e5e24b2..66126745b 100644
--- a/src/multimedia/platform/qplatformvideosink.cpp
+++ b/src/multimedia/platform/qplatformvideosink.cpp
@@ -43,11 +43,10 @@ QT_BEGIN_NAMESPACE
/*!
\class QPlatformVideoSink
- \obsolete
+ \internal
\inmodule QtMultimedia
- \ingroup multimedia_control
\brief The QPlatformVideoSink class provides a media control for rendering video to a window.
QPlatformVideoSink is one of a number of possible video output controls.
diff --git a/src/multimedia/playback/qmediaplayer.cpp b/src/multimedia/playback/qmediaplayer.cpp
index fdb486538..31d816e34 100644
--- a/src/multimedia/playback/qmediaplayer.cpp
+++ b/src/multimedia/playback/qmediaplayer.cpp
@@ -390,7 +390,7 @@ QMediaTimeRange QMediaPlayer::bufferedTimeRange() const
*/
/*!
- \property bool QMediaPlayer::hasAudio
+ \property QMediaPlayer::hasAudio
\brief This property holds whether the media contains audio.
*/
bool QMediaPlayer::hasAudio() const
@@ -410,7 +410,7 @@ bool QMediaPlayer::hasAudio() const
*/
/*!
- \property bool QMediaPlayer::hasVideo
+ \property QMediaPlayer::hasVideo
\brief This property holds whether the media contains video.
*/
bool QMediaPlayer::hasVideo() const
@@ -468,7 +468,7 @@ QMediaPlayer::Error QMediaPlayer::error() const
*/
/*!
- \property string QtMultimedia::MediaPlayer::errorString
+ \property QMediaPlayer::errorString
\brief This property holds a string describing the current error condition in
more detail.
*/
@@ -673,7 +673,7 @@ QAudioOutput *QMediaPlayer::audioOutput() const
Each index refers to an audio track.
The metadata holds properties describing the individual tracks. For
- audio tracks the \l{language}{MediaMetaData::Language} is usually the most
+ audio tracks the \l{MediaMetaData::Language}{language} is usually the most
important property.
\sa mediaMetaData
@@ -723,7 +723,7 @@ QList<QMediaMetaData> QMediaPlayer::videoTracks() const
Each index refers to a subtitle track.
The metadata holds properties describing the individual tracks. For
- subtitle tracks the \l{language}{MediaMetaData::Language} is usually the most
+ subtitle tracks the \l{MediaMetaData::Language}{language} is usually the most
important property.
\sa mediaMetaData
@@ -942,9 +942,23 @@ bool QMediaPlayer::isAvailable() const
}
/*!
+ \qmlproperty mediaMetaData QtMultimedia::MediaPlayer::metaData
+
Returns meta data for the current media used by the media player.
- Meta data can contain information such as the title of the video or it's creation date.
+ Meta data can contain information such as the title of the video or its creation date.
+
+ \note The Windows implementation provides metadata only for media located on the local file
+ system.
+*/
+
+/*!
+ Returns meta data for the current media used by the media player.
+
+ Meta data can contain information such as the title of the video or its creation date.
+
+ \note The Windows implementation provides metadata only for media located on the local file
+ system.
*/
QMediaMetaData QMediaPlayer::metaData() const
{
@@ -1219,26 +1233,6 @@ QMediaMetaData QMediaPlayer::metaData() const
*/
/*!
- \property QMediaPlayer::hasAudio
- \brief the audio availabilty status for the current media.
-
- \note As the life time of QMediaPlayer can be longer than the playback of
- one QUrl, this property may change over time.
-*/
-
-/*!
- \property QMediaPlayer::hasVideo
- \brief the video availability status for the current media.
-
- If available, the QVideoWidget class can be used to view the video.
-
- \note As the life time of QMediaPlayer can be longer than the playback of
- one QUrl, this property may change over time.
-
- \sa QVideoWidget, QUrl
-*/
-
-/*!
\qmlproperty bool QtMultimedia::MediaPlayer::seekable
This property holds whether the \l position of the media can be changed.
diff --git a/src/multimedia/qmediaformat.cpp b/src/multimedia/qmediaformat.cpp
index 49e9fda47..aca22205a 100644
--- a/src/multimedia/qmediaformat.cpp
+++ b/src/multimedia/qmediaformat.cpp
@@ -279,7 +279,7 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QMediaFormatPrivate);
\omitvalue LastAudioCodec
*/
-/*! \qmlproperty enumeration QMediaFormat::audioCodec
+/*! \qmlproperty enumeration QtMultimedia::mediaFormat::audioCodec
Describes the audio codec used in multimedia file or stream.
It can take one of the following values:
@@ -346,7 +346,7 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QMediaFormatPrivate);
\omitvalue LastVideoCodec
*/
-/*! \qmlproperty QtMultimedia::mediaFormat::videoCodec
+/*! \qmlproperty enumeration QtMultimedia::mediaFormat::videoCodec
Describes the video codec used in multimedia file or stream.
It can take one of the following values:
@@ -417,11 +417,6 @@ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = defa
*/
// Properties
-/*! \qmlproperty QtMultimedia::mediaFormat::fileFormat
-
- The file (container) format of the media.
-*/
-
/*! \property QMediaFormat::fileFormat
\brief The file (container) format of the media.
@@ -429,11 +424,6 @@ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = defa
\sa QMediaFormat::FileFormat
*/
-/*! \qmlproperty QtMultimedia::mediaFormat::audioCodec
-
- The audio codec of the media.
-*/
-
/*! \property QMediaFormat::audioCodec
\brief The audio codec of the media.
@@ -441,11 +431,6 @@ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = defa
\sa QMediaFormat::AudioCodec
*/
-/*! \qmlproperty QtMultimedia::mediaFormat::videoCodec
-
- The video codec of the media.
-*/
-
/*! \property QMediaFormat::videoCodec
\brief The video codec of the media.
@@ -669,7 +654,7 @@ QString QMediaFormat::audioCodecName(QMediaFormat::AudioCodec codec)
/*!
Returns a string based name for \a codec.
*/
-QString QMediaFormat::videoCodecName(QMediaFormat::VideoCodec c)
+QString QMediaFormat::videoCodecName(QMediaFormat::VideoCodec codec)
{
constexpr const char *descriptions[] = {
"Invalid",
@@ -685,7 +670,7 @@ QString QMediaFormat::videoCodecName(QMediaFormat::VideoCodec c)
"WMV",
"MotionJPEG"
};
- return QString::fromUtf8(descriptions[int(c) + 1]);
+ return QString::fromUtf8(descriptions[int(codec) + 1]);
}
/*!
diff --git a/src/multimedia/qmediametadata.cpp b/src/multimedia/qmediametadata.cpp
index bee821fbd..85daa9a36 100644
--- a/src/multimedia/qmediametadata.cpp
+++ b/src/multimedia/qmediametadata.cpp
@@ -216,16 +216,16 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod variant QtMultimedia::mediaMetaData::value(QMediaMetaData::Key key)
+ \qmlmethod variant QtMultimedia::mediaMetaData::value(Key key)
Returns the meta data value for Key \a key, or a null QVariant if no
meta-data for the key is available.
*/
/*!
- \fn variant QMediaMetaData::value(QMediaMetaData::Key key) const
+ \fn QVariant QMediaMetaData::value(QMediaMetaData::Key key) const
- Returns the meta data value for Key \a key, or a null QVariant is not
+ Returns the meta data value for Key \a key, or a null QVariant if no
meta data for the key is available.
*/
@@ -235,7 +235,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \fn bool QMediaMetaData::isEmpty()
+ \fn bool QMediaMetaData::isEmpty() const
Returns \c true if the meta data contains no items: otherwise returns \c{false}.
*/
@@ -274,7 +274,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \fn QList QMediaMetaData::keys()
+ \fn QList QMediaMetaData::keys() const
Returns a QList of QMediaMetaData::Keys.
*/
@@ -426,18 +426,18 @@ QString QMediaMetaData::metaDataKeyToString(QMediaMetaData::Key key)
/*!
\fn bool QMediaMetaData::operator==(const QMediaMetaData &a, const QMediaMetaData &b)
- The \c == operator will compare two meta data objects, and return
+ Compares two meta data objects \a a and \a b, and returns
\c true if they are identical or \c false if they differ.
*/
/*!
\fn bool QMediaMetaData::operator!=(const QMediaMetaData &a, const QMediaMetaData &b)
- The \c != operator will compare two meta data objects, and return
+ Compares two meta data objects \a a and \a b, and returns
\c false if they are identical or \c true if they differ.
*/
/*!
-\property QHash<Key, QVariant> QMediaMetaData::data
+ \variable QHash<Key, QVariant> QMediaMetaData::data
This property holds the metaData.
\note this is a \c protected member of its class.
*/
diff --git a/src/multimedia/recording/qmediacapturesession.cpp b/src/multimedia/recording/qmediacapturesession.cpp
index 0d9ba8d78..1a827ad7a 100644
--- a/src/multimedia/recording/qmediacapturesession.cpp
+++ b/src/multimedia/recording/qmediacapturesession.cpp
@@ -146,7 +146,7 @@ public:
}
\endqml
- \sa Camera, MediaDevice, MediaRecorder, ImageCapture, AudioInput, VideoOutput
+ \sa Camera, MediaDevices, MediaRecorder, ImageCapture, AudioInput, VideoOutput
*/
/*!
@@ -179,8 +179,7 @@ QMediaCaptureSession::~QMediaCaptureSession()
/*!
\qmlproperty AudioInput QtMultimedia::CaptureSession::audioInput
- This property holds the audio input that is being used to capture audio..
- \sa setAudioInput()
+ This property holds the audio input that is being used to capture audio.
*/
/*!
@@ -192,16 +191,16 @@ QAudioInput *QMediaCaptureSession::audioInput() const
}
/*!
- Sets the audio input device to \a device. If setting it to an empty
+ Sets the audio input device to \a input. If setting it to an empty
QAudioDevice the capture session will use the default input as
defined by the operating system.
*/
-void QMediaCaptureSession::setAudioInput(QAudioInput *device)
+void QMediaCaptureSession::setAudioInput(QAudioInput *input)
{
- if (d_ptr->audioInput == device)
+ if (d_ptr->audioInput == input)
return;
- d_ptr->audioInput = device;
- d_ptr->captureSession->setAudioInput(device ? device->handle() : nullptr);
+ d_ptr->audioInput = input;
+ d_ptr->captureSession->setAudioInput(input ? input->handle() : nullptr);
emit audioInputChanged();
}
diff --git a/src/multimedia/recording/qmediacapturesession.h b/src/multimedia/recording/qmediacapturesession.h
index 5ae152d8e..5941ccaf1 100644
--- a/src/multimedia/recording/qmediacapturesession.h
+++ b/src/multimedia/recording/qmediacapturesession.h
@@ -69,7 +69,7 @@ public:
~QMediaCaptureSession();
QAudioInput *audioInput() const;
- void setAudioInput(QAudioInput *device);
+ void setAudioInput(QAudioInput *input);
QCamera *camera() const;
void setCamera(QCamera *camera);
diff --git a/src/multimedia/recording/qmediarecorder.cpp b/src/multimedia/recording/qmediarecorder.cpp
index e7a0b082c..36d8a2f86 100644
--- a/src/multimedia/recording/qmediarecorder.cpp
+++ b/src/multimedia/recording/qmediarecorder.cpp
@@ -586,7 +586,7 @@ QMediaCaptureSession *QMediaRecorder::captureSession() const
return d->captureSession;
}
/*!
- \qmlproprty enumeration QtMultimedia::MediaRecorder::quality
+ \qmlproperty enumeration QtMultimedia::MediaRecorder::quality
Enumerates quality encoding levels.
diff --git a/src/multimedia/video/qvideoframeformat.cpp b/src/multimedia/video/qvideoframeformat.cpp
index 9685aac19..c8e691d1e 100644
--- a/src/multimedia/video/qvideoframeformat.cpp
+++ b/src/multimedia/video/qvideoframeformat.cpp
@@ -281,7 +281,7 @@ Format_RGBA8888
*/
/*!
- Constructs a null video stream format.
+ Constructs a null video frame format.
*/
QVideoFrameFormat::QVideoFrameFormat()
: d(new QVideoFrameFormatPrivate)
@@ -290,7 +290,7 @@ QVideoFrameFormat::QVideoFrameFormat()
}
/*!
- Constructs a description of stream which receives stream of \a d type buffers with given frame
+ Constructs a video frame format with given frame
\a size and pixel \a format.
*/
QVideoFrameFormat::QVideoFrameFormat(
diff --git a/src/multimedia/video/qvideosink.cpp b/src/multimedia/video/qvideosink.cpp
index a35a04812..5d8058bde 100644
--- a/src/multimedia/video/qvideosink.cpp
+++ b/src/multimedia/video/qvideosink.cpp
@@ -167,7 +167,7 @@ QVideoFrame QVideoSink::videoFrame() const
}
/*!
- Sets the current video frame.
+ Sets the current video frame to \a frame.
*/
void QVideoSink::setVideoFrame(const QVideoFrame &frame)
{
@@ -183,7 +183,7 @@ QString QVideoSink::subtitleText() const
}
/*!
- Sets the current subtitle text.
+ Sets the current subtitle text to \a subtitle.
*/
void QVideoSink::setSubtitleText(const QString &subtitle)
{
diff --git a/src/multimedia/video/qvideowindow.cpp b/src/multimedia/video/qvideowindow.cpp
index 56b2281c8..f0ae26b98 100644
--- a/src/multimedia/video/qvideowindow.cpp
+++ b/src/multimedia/video/qvideowindow.cpp
@@ -451,6 +451,7 @@ void QVideoWindowPrivate::render()
/*!
\class QVideoWindow
+ \internal
*/
QVideoWindow::QVideoWindow(QScreen *screen)
: QWindow(screen)
diff --git a/src/multimediaquick/qquickimagecapture.cpp b/src/multimediaquick/qquickimagecapture.cpp
index 7a9771fb6..87f5b15a8 100644
--- a/src/multimediaquick/qquickimagecapture.cpp
+++ b/src/multimediaquick/qquickimagecapture.cpp
@@ -145,7 +145,7 @@ QQuickImageCapture::~QQuickImageCapture() = default;
capture() returns the capture requestId parameter, used with
imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.
- \sa ready, preview
+ \sa readyForCapture, preview
*/
/*!
@@ -183,9 +183,10 @@ void QQuickImageCapture::_q_imageCaptured(int id, const QImage &preview)
}
/*!
- \qmlsignal QtMultimedia::ImageCapture::errorOccurred(requestId, Error, message)
+ \qmlsignal QtMultimedia::ImageCapture::errorOccurred(requestId, error, message)
This signal is emitted when an error occurs during capture with \a requestId.
+ \a error is an enumeration of type ImageCapture::Error.
A descriptive message is available in \a message.
*/
diff --git a/src/multimediaquick/qquickvideooutput.cpp b/src/multimediaquick/qquickvideooutput.cpp
index 6cef7027a..fd0b77205 100644
--- a/src/multimediaquick/qquickvideooutput.cpp
+++ b/src/multimediaquick/qquickvideooutput.cpp
@@ -267,8 +267,6 @@ void QQuickVideoOutput::_q_updateGeometry()
The orientation change will also affect the mapping
of coordinates from source to viewport.
-
- \sa autoOrientation
*/
int QQuickVideoOutput::orientation() const
{