summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/gsttools/qgstutils.cpp9
-rw-r--r--src/multimedia/audio/qaudioinput.h2
-rw-r--r--src/multimedia/audio/qaudiooutput.h2
-rw-r--r--src/multimedia/audio/qaudioprobe.h2
-rw-r--r--src/multimedia/audio/qaudiosystem.h11
-rw-r--r--src/multimedia/audio/qaudiosystemplugin.cpp9
-rw-r--r--src/multimedia/audio/qaudiosystemplugin.h6
-rw-r--r--src/multimedia/camera/qcamera.cpp15
-rw-r--r--src/multimedia/camera/qcamera.h8
-rw-r--r--src/multimedia/camera/qcameraexposure.h2
-rw-r--r--src/multimedia/camera/qcameraimagecapture.cpp4
-rw-r--r--src/multimedia/camera/qcameraimagecapture.h8
-rw-r--r--src/multimedia/controls/qaudiodecodercontrol.cpp4
-rw-r--r--src/multimedia/controls/qaudioencodersettingscontrol.cpp4
-rw-r--r--src/multimedia/controls/qaudioencodersettingscontrol.h2
-rw-r--r--src/multimedia/controls/qcameracapturebufferformatcontrol.h2
-rw-r--r--src/multimedia/controls/qcameracapturedestinationcontrol.h2
-rw-r--r--src/multimedia/controls/qcameracontrol.h2
-rw-r--r--src/multimedia/controls/qcameraimagecapturecontrol.h10
-rw-r--r--src/multimedia/controls/qcameralockscontrol.cpp2
-rw-r--r--src/multimedia/controls/qimageencodercontrol.h5
-rw-r--r--src/multimedia/controls/qmediacontainercontrol.cpp4
-rw-r--r--src/multimedia/controls/qmediaplayercontrol.cpp8
-rw-r--r--src/multimedia/controls/qmediaplayercontrol.h8
-rw-r--r--src/multimedia/controls/qmediastreamscontrol.cpp16
-rw-r--r--src/multimedia/controls/qvideodeviceselectorcontrol.h2
-rw-r--r--src/multimedia/controls/qvideoencodersettingscontrol.h2
-rw-r--r--src/multimedia/doc/QtMultimediaDoc3
-rw-r--r--src/multimedia/doc/qtmultimedia.qdocconf3
-rw-r--r--src/multimedia/qmediaserviceprovider.cpp2
-rw-r--r--src/multimedia/qmediatimerange.cpp22
-rw-r--r--src/multimedia/video/qabstractvideosurface.h4
-rw-r--r--src/multimedia/video/qvideoprobe.h2
-rw-r--r--src/multimedia/video/qvideosurfaceformat.cpp2
-rw-r--r--src/multimedia/video/qvideosurfaceformat.h2
35 files changed, 85 insertions, 106 deletions
diff --git a/src/gsttools/qgstutils.cpp b/src/gsttools/qgstutils.cpp
index 6a573fa78..8849208d3 100644
--- a/src/gsttools/qgstutils.cpp
+++ b/src/gsttools/qgstutils.cpp
@@ -175,6 +175,11 @@ static void addTagToMap(const GstTagList *list,
}
/*!
+ \class QGstUtils
+ \internal
+/*
+
+/*!
Convert GstTagList structure to QMap<QByteArray, QVariant>.
Mapping to int, bool, char, string, fractions and date are supported.
@@ -190,7 +195,7 @@ QMap<QByteArray, QVariant> QGstUtils::gstTagListToMap(const GstTagList *tags)
/*!
Returns resolution of \a caps.
- If caps doesn't have a valid size, and ampty QSize is returned.
+ If caps doesn't have a valid size, an empty QSize is returned.
*/
QSize QGstUtils::capsResolution(const GstCaps *caps)
{
@@ -361,7 +366,7 @@ QAudioFormat QGstUtils::audioFormatForCaps(const GstCaps *caps)
}
#if GST_CHECK_VERSION(1,0,0)
-/*!
+/*
Returns audio format for a sample.
If the buffer doesn't have a valid audio format, an empty QAudioFormat is returned.
*/
diff --git a/src/multimedia/audio/qaudioinput.h b/src/multimedia/audio/qaudioinput.h
index db482a145..b17fd4d79 100644
--- a/src/multimedia/audio/qaudioinput.h
+++ b/src/multimedia/audio/qaudioinput.h
@@ -95,7 +95,7 @@ public:
QAudio::State state() const;
Q_SIGNALS:
- void stateChanged(QAudio::State);
+ void stateChanged(QAudio::State state);
void notify();
private:
diff --git a/src/multimedia/audio/qaudiooutput.h b/src/multimedia/audio/qaudiooutput.h
index 1c037cd2b..5f466d8e1 100644
--- a/src/multimedia/audio/qaudiooutput.h
+++ b/src/multimedia/audio/qaudiooutput.h
@@ -98,7 +98,7 @@ public:
void setCategory(const QString &category);
Q_SIGNALS:
- void stateChanged(QAudio::State);
+ void stateChanged(QAudio::State state);
void notify();
private:
diff --git a/src/multimedia/audio/qaudioprobe.h b/src/multimedia/audio/qaudioprobe.h
index a3fc4598d..e0d5619d2 100644
--- a/src/multimedia/audio/qaudioprobe.h
+++ b/src/multimedia/audio/qaudioprobe.h
@@ -62,7 +62,7 @@ public:
bool isActive() const;
Q_SIGNALS:
- void audioBufferProbed(const QAudioBuffer &audioBuffer);
+ void audioBufferProbed(const QAudioBuffer &buffer);
void flush();
private:
diff --git a/src/multimedia/audio/qaudiosystem.h b/src/multimedia/audio/qaudiosystem.h
index dabf8df0b..c326460fe 100644
--- a/src/multimedia/audio/qaudiosystem.h
+++ b/src/multimedia/audio/qaudiosystem.h
@@ -51,9 +51,6 @@ QT_BEGIN_NAMESPACE
class QIODevice;
-// Required for QDoc workaround
-class QString;
-
class Q_MULTIMEDIA_EXPORT QAbstractAudioDeviceInfo : public QObject
{
Q_OBJECT
@@ -99,8 +96,8 @@ public:
virtual void setCategory(const QString &) { }
Q_SIGNALS:
- void errorChanged(QAudio::Error);
- void stateChanged(QAudio::State);
+ void errorChanged(QAudio::Error error);
+ void stateChanged(QAudio::State state);
void notify();
};
@@ -131,8 +128,8 @@ public:
virtual qreal volume() const = 0;
Q_SIGNALS:
- void errorChanged(QAudio::Error);
- void stateChanged(QAudio::State);
+ void errorChanged(QAudio::Error error);
+ void stateChanged(QAudio::State state);
void notify();
};
diff --git a/src/multimedia/audio/qaudiosystemplugin.cpp b/src/multimedia/audio/qaudiosystemplugin.cpp
index 6a255cf11..cb5628477 100644
--- a/src/multimedia/audio/qaudiosystemplugin.cpp
+++ b/src/multimedia/audio/qaudiosystemplugin.cpp
@@ -90,7 +90,9 @@ QAudioSystemPluginExtension::~QAudioSystemPluginExtension()
*/
/*!
- Construct a new audio plugin with \a parent.
+ \fn QAudioSystemPlugin::QAudioSystemPlugin(QObject* parent)
+
+ Constructs a new audio plugin with \a parent.
This is invoked automatically by the Q_PLUGIN_METADATA() macro.
*/
@@ -99,9 +101,10 @@ QAudioSystemPlugin::QAudioSystemPlugin(QObject* parent) :
{}
/*!
- Destroy the audio plugin
+ \fn QAudioSystemPlugin::~QAudioSystemPlugin()
- You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.
+ Destroys the audio plugin.
+ You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.
*/
QAudioSystemPlugin::~QAudioSystemPlugin()
diff --git a/src/multimedia/audio/qaudiosystemplugin.h b/src/multimedia/audio/qaudiosystemplugin.h
index 3539201a2..18079e9d9 100644
--- a/src/multimedia/audio/qaudiosystemplugin.h
+++ b/src/multimedia/audio/qaudiosystemplugin.h
@@ -53,9 +53,6 @@
QT_BEGIN_NAMESPACE
-// Required for QDoc workaround
-class QString;
-
struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
{
virtual QList<QByteArray> availableDevices(QAudio::Mode) const = 0;
@@ -69,9 +66,6 @@ struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
"org.qt-project.qt.audiosystemfactory/5.0"
Q_DECLARE_INTERFACE(QAudioSystemFactoryInterface, QAudioSystemFactoryInterface_iid)
-// Required for QDoc workaround
-class QString;
-
class Q_MULTIMEDIA_EXPORT QAudioSystemPlugin : public QObject, public QAudioSystemFactoryInterface
{
Q_OBJECT
diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index fd804316c..722c5b629 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -478,11 +478,11 @@ QCameraImageProcessing *QCamera::imageProcessing() const
}
/*!
- Sets the QVideoWidget based camera \a viewfinder.
- The previously set viewfinder is detached.
-*/
+ Sets the QVideoWidget based camera \a viewfinder.
+ The previously set viewfinder is detached.
-// QVideoWidget is forward declared
+ //! QVideoWidget is forward declared.
+*/
void QCamera::setViewfinder(QVideoWidget *viewfinder)
{
Q_D(QCamera);
@@ -498,10 +498,11 @@ void QCamera::setViewfinder(QVideoWidget *viewfinder)
}
/*!
- Sets the QGraphicsVideoItem based camera \a viewfinder.
- The previously set viewfinder is detached.
+ Sets the QGraphicsVideoItem based camera \a viewfinder.
+ The previously set viewfinder is detached.
+
+ //! QGraphicsVideoItem is forward declared.
*/
-// QGraphicsVideoItem is forward declared
void QCamera::setViewfinder(QGraphicsVideoItem *viewfinder)
{
Q_D(QCamera);
diff --git a/src/multimedia/camera/qcamera.h b/src/multimedia/camera/qcamera.h
index 06187fec0..b2582cd19 100644
--- a/src/multimedia/camera/qcamera.h
+++ b/src/multimedia/camera/qcamera.h
@@ -232,15 +232,15 @@ public Q_SLOTS:
void unlock(QCamera::LockTypes locks);
Q_SIGNALS:
- void stateChanged(QCamera::State);
+ void stateChanged(QCamera::State state);
void captureModeChanged(QCamera::CaptureModes);
- void statusChanged(QCamera::Status);
+ void statusChanged(QCamera::Status status);
void locked();
void lockFailed();
- void lockStatusChanged(QCamera::LockStatus, QCamera::LockChangeReason);
- void lockStatusChanged(QCamera::LockType, QCamera::LockStatus, QCamera::LockChangeReason);
+ void lockStatusChanged(QCamera::LockStatus status, QCamera::LockChangeReason reason);
+ void lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason);
void error(QCamera::Error);
diff --git a/src/multimedia/camera/qcameraexposure.h b/src/multimedia/camera/qcameraexposure.h
index 336d4c0b3..f8eb68fbf 100644
--- a/src/multimedia/camera/qcameraexposure.h
+++ b/src/multimedia/camera/qcameraexposure.h
@@ -160,7 +160,7 @@ Q_SIGNALS:
void apertureChanged(qreal);
void apertureRangeChanged();
- void shutterSpeedChanged(qreal);
+ void shutterSpeedChanged(qreal speed);
void shutterSpeedRangeChanged();
void isoSensitivityChanged(int);
void exposureCompensationChanged(qreal);
diff --git a/src/multimedia/camera/qcameraimagecapture.cpp b/src/multimedia/camera/qcameraimagecapture.cpp
index 03089e006..cedae2609 100644
--- a/src/multimedia/camera/qcameraimagecapture.cpp
+++ b/src/multimedia/camera/qcameraimagecapture.cpp
@@ -632,9 +632,9 @@ void QCameraImageCapture::cancelCapture()
*/
/*!
- \fn QCameraImageCapture::imageAvailable(int id, const QVideoFrame &buffer)
+ \fn QCameraImageCapture::imageAvailable(int id, const QVideoFrame &frame)
- Signal emitted when the frame with request \a id is available as \a buffer.
+ Signal emitted when the \a frame with request \a id is available.
*/
/*!
diff --git a/src/multimedia/camera/qcameraimagecapture.h b/src/multimedia/camera/qcameraimagecapture.h
index 6fedb7e2c..931fe3902 100644
--- a/src/multimedia/camera/qcameraimagecapture.h
+++ b/src/multimedia/camera/qcameraimagecapture.h
@@ -124,14 +124,14 @@ public Q_SLOTS:
Q_SIGNALS:
void error(int id, QCameraImageCapture::Error error, const QString &errorString);
- void readyForCaptureChanged(bool);
- void bufferFormatChanged(QVideoFrame::PixelFormat);
- void captureDestinationChanged(QCameraImageCapture::CaptureDestinations);
+ void readyForCaptureChanged(bool ready);
+ void bufferFormatChanged(QVideoFrame::PixelFormat format);
+ void captureDestinationChanged(QCameraImageCapture::CaptureDestinations destination);
void imageExposed(int id);
void imageCaptured(int id, const QImage &preview);
void imageMetadataAvailable(int id, const QString &key, const QVariant &value);
- void imageAvailable(int id, const QVideoFrame &image);
+ void imageAvailable(int id, const QVideoFrame &frame);
void imageSaved(int id, const QString &fileName);
protected:
diff --git a/src/multimedia/controls/qaudiodecodercontrol.cpp b/src/multimedia/controls/qaudiodecodercontrol.cpp
index b224ae683..09448ca41 100644
--- a/src/multimedia/controls/qaudiodecodercontrol.cpp
+++ b/src/multimedia/controls/qaudiodecodercontrol.cpp
@@ -96,9 +96,9 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
*/
/*!
- \fn QAudioDecoderControl::stateChanged(QAudioDecoder::State state)
+ \fn QAudioDecoderControl::stateChanged(QAudioDecoder::State newState)
- Signals that the \a state of a player control has changed.
+ Signals that the state of a player control has changed to \a newState.
\sa state()
*/
diff --git a/src/multimedia/controls/qaudioencodersettingscontrol.cpp b/src/multimedia/controls/qaudioencodersettingscontrol.cpp
index 60ba633b6..ad0437c6e 100644
--- a/src/multimedia/controls/qaudioencodersettingscontrol.cpp
+++ b/src/multimedia/controls/qaudioencodersettingscontrol.cpp
@@ -98,9 +98,9 @@ QAudioEncoderSettingsControl::~QAudioEncoderSettingsControl()
*/
/*!
- \fn QAudioEncoderSettingsControl::codecDescription(const QString &codec) const
+ \fn QAudioEncoderSettingsControl::codecDescription(const QString &codecName) const
- Returns description of audio \a codec.
+ Returns the description of audio codec \a codecName.
*/
/*!
diff --git a/src/multimedia/controls/qaudioencodersettingscontrol.h b/src/multimedia/controls/qaudioencodersettingscontrol.h
index 1f973f0ea..ebfa8ad8e 100644
--- a/src/multimedia/controls/qaudioencodersettingscontrol.h
+++ b/src/multimedia/controls/qaudioencodersettingscontrol.h
@@ -70,7 +70,7 @@ public:
bool *continuous = nullptr) const = 0;
virtual QAudioEncoderSettings audioSettings() const = 0;
- virtual void setAudioSettings(const QAudioEncoderSettings&) = 0;
+ virtual void setAudioSettings(const QAudioEncoderSettings &settings) = 0;
protected:
explicit QAudioEncoderSettingsControl(QObject *parent = nullptr);
diff --git a/src/multimedia/controls/qcameracapturebufferformatcontrol.h b/src/multimedia/controls/qcameracapturebufferformatcontrol.h
index c659384b6..1c8f44243 100644
--- a/src/multimedia/controls/qcameracapturebufferformatcontrol.h
+++ b/src/multimedia/controls/qcameracapturebufferformatcontrol.h
@@ -59,7 +59,7 @@ public:
virtual void setBufferFormat(QVideoFrame::PixelFormat format) = 0;
Q_SIGNALS:
- void bufferFormatChanged(QVideoFrame::PixelFormat);
+ void bufferFormatChanged(QVideoFrame::PixelFormat format);
protected:
explicit QCameraCaptureBufferFormatControl(QObject *parent = nullptr);
diff --git a/src/multimedia/controls/qcameracapturedestinationcontrol.h b/src/multimedia/controls/qcameracapturedestinationcontrol.h
index 30d69d47a..395f8c511 100644
--- a/src/multimedia/controls/qcameracapturedestinationcontrol.h
+++ b/src/multimedia/controls/qcameracapturedestinationcontrol.h
@@ -59,7 +59,7 @@ public:
virtual void setCaptureDestination(QCameraImageCapture::CaptureDestinations destination) = 0;
Q_SIGNALS:
- void captureDestinationChanged(QCameraImageCapture::CaptureDestinations);
+ void captureDestinationChanged(QCameraImageCapture::CaptureDestinations destination);
protected:
explicit QCameraCaptureDestinationControl(QObject *parent = nullptr);
diff --git a/src/multimedia/controls/qcameracontrol.h b/src/multimedia/controls/qcameracontrol.h
index f7a1b4288..6c5163118 100644
--- a/src/multimedia/controls/qcameracontrol.h
+++ b/src/multimedia/controls/qcameracontrol.h
@@ -80,7 +80,7 @@ Q_SIGNALS:
void stateChanged(QCamera::State);
void statusChanged(QCamera::Status);
void error(int error, const QString &errorString);
- void captureModeChanged(QCamera::CaptureModes);
+ void captureModeChanged(QCamera::CaptureModes mode);
protected:
explicit QCameraControl(QObject *parent = nullptr);
diff --git a/src/multimedia/controls/qcameraimagecapturecontrol.h b/src/multimedia/controls/qcameraimagecapturecontrol.h
index e6700fce5..72b0abda3 100644
--- a/src/multimedia/controls/qcameraimagecapturecontrol.h
+++ b/src/multimedia/controls/qcameraimagecapturecontrol.h
@@ -69,13 +69,13 @@ public:
virtual void cancelCapture() = 0;
Q_SIGNALS:
- void readyForCaptureChanged(bool);
+ void readyForCaptureChanged(bool ready);
- void imageExposed(int id);
- void imageCaptured(int id, const QImage &preview);
+ void imageExposed(int requestId);
+ void imageCaptured(int requestId, const QImage &preview);
void imageMetadataAvailable(int id, const QString &key, const QVariant &value);
- void imageAvailable(int id, const QVideoFrame &buffer);
- void imageSaved(int id, const QString &fileName);
+ void imageAvailable(int requestId, const QVideoFrame &buffer);
+ void imageSaved(int requestId, const QString &fileName);
void error(int id, int error, const QString &errorString);
diff --git a/src/multimedia/controls/qcameralockscontrol.cpp b/src/multimedia/controls/qcameralockscontrol.cpp
index d188576ff..d8d6e61cd 100644
--- a/src/multimedia/controls/qcameralockscontrol.cpp
+++ b/src/multimedia/controls/qcameralockscontrol.cpp
@@ -119,7 +119,7 @@ QCameraLocksControl::~QCameraLocksControl()
/*!
\fn QCameraLocksControl::lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason)
- Signals the \a lock \a status was changed with a specified \a reason.
+ Signals the lock \a type \a status was changed with the specified \a reason.
*/
diff --git a/src/multimedia/controls/qimageencodercontrol.h b/src/multimedia/controls/qimageencodercontrol.h
index 9c2164413..0cb4b4333 100644
--- a/src/multimedia/controls/qimageencodercontrol.h
+++ b/src/multimedia/controls/qimageencodercontrol.h
@@ -54,9 +54,6 @@ QT_END_NAMESPACE
QT_BEGIN_NAMESPACE
-// Required for QDoc workaround
-class QString;
-
class Q_MULTIMEDIA_EXPORT QImageEncoderControl : public QMediaControl
{
Q_OBJECT
@@ -65,7 +62,7 @@ public:
virtual ~QImageEncoderControl();
virtual QStringList supportedImageCodecs() const = 0;
- virtual QString imageCodecDescription(const QString &codecName) const = 0;
+ virtual QString imageCodecDescription(const QString &codec) const = 0;
virtual QList<QSize> supportedResolutions(const QImageEncoderSettings &settings,
bool *continuous = nullptr) const = 0;
diff --git a/src/multimedia/controls/qmediacontainercontrol.cpp b/src/multimedia/controls/qmediacontainercontrol.cpp
index 34b759a6a..1b6c4bf03 100644
--- a/src/multimedia/controls/qmediacontainercontrol.cpp
+++ b/src/multimedia/controls/qmediacontainercontrol.cpp
@@ -111,9 +111,9 @@ QMediaContainerControl::~QMediaContainerControl()
*/
/*!
- \fn QMediaContainerControl::containerDescription(const QString &format) const
+ \fn QMediaContainerControl::containerDescription(const QString &formatMimeType) const
- Returns a description of the container \a format.
+ Returns a description of the container \a formatMimeType.
*/
#include "moc_qmediacontainercontrol.cpp"
diff --git a/src/multimedia/controls/qmediaplayercontrol.cpp b/src/multimedia/controls/qmediaplayercontrol.cpp
index 07b277ffb..23c02d57f 100644
--- a/src/multimedia/controls/qmediaplayercontrol.cpp
+++ b/src/multimedia/controls/qmediaplayercontrol.cpp
@@ -104,9 +104,9 @@ QMediaPlayerControl::QMediaPlayerControl(QObject *parent):
*/
/*!
- \fn QMediaPlayerControl::stateChanged(QMediaPlayer::State state)
+ \fn QMediaPlayerControl::stateChanged(QMediaPlayer::State newState)
- Signals that the \a state of a player control has changed.
+ Signals that the state of a player control has changed to \a newState.
\sa state()
*/
@@ -231,9 +231,9 @@ QMediaPlayerControl::QMediaPlayerControl(QObject *parent):
*/
/*!
- \fn QMediaPlayerControl::audioAvailableChanged(bool audio)
+ \fn QMediaPlayerControl::audioAvailableChanged(bool audioAvailable)
- Signals that there has been a change in the availability of \a audio output.
+ Signals that there has been a change in the availability of audio output \a audioAvailable.
\sa isAudioAvailable()
*/
diff --git a/src/multimedia/controls/qmediaplayercontrol.h b/src/multimedia/controls/qmediaplayercontrol.h
index d231097f4..8b5072572 100644
--- a/src/multimedia/controls/qmediaplayercontrol.h
+++ b/src/multimedia/controls/qmediaplayercontrol.h
@@ -71,7 +71,7 @@ public:
virtual void setVolume(int volume) = 0;
virtual bool isMuted() const = 0;
- virtual void setMuted(bool muted) = 0;
+ virtual void setMuted(bool mute) = 0;
virtual int bufferStatus() const = 0;
@@ -100,12 +100,12 @@ Q_SIGNALS:
void stateChanged(QMediaPlayer::State newState);
void mediaStatusChanged(QMediaPlayer::MediaStatus status);
void volumeChanged(int volume);
- void mutedChanged(bool muted);
+ void mutedChanged(bool mute);
void audioAvailableChanged(bool audioAvailable);
void videoAvailableChanged(bool videoAvailable);
void bufferStatusChanged(int percentFilled);
- void seekableChanged(bool);
- void availablePlaybackRangesChanged(const QMediaTimeRange&);
+ void seekableChanged(bool seekable);
+ void availablePlaybackRangesChanged(const QMediaTimeRange &ranges);
void playbackRateChanged(qreal rate);
void error(int error, const QString &errorString);
diff --git a/src/multimedia/controls/qmediastreamscontrol.cpp b/src/multimedia/controls/qmediastreamscontrol.cpp
index ad1c62f15..2daf50de8 100644
--- a/src/multimedia/controls/qmediastreamscontrol.cpp
+++ b/src/multimedia/controls/qmediastreamscontrol.cpp
@@ -113,30 +113,30 @@ QMediaStreamsControl::~QMediaStreamsControl()
*/
/*!
- \fn QMediaStreamsControl::streamType(int stream)
+ \fn QMediaStreamsControl::streamType(int streamNumber)
- Return the type of a media \a stream.
+ Return the type of media stream \a streamNumber.
*/
/*!
- \fn QMediaStreamsControl::metaData(int stream, const QString &key)
+ \fn QMediaStreamsControl::metaData(int streamNumber, const QString &key)
- Returns the meta-data value of \a key for a given \a stream.
+ Returns the meta-data value of \a key for the given \a streamNumber.
Useful metadata keys are QMediaMetaData::Title,
QMediaMetaData::Description and QMediaMetaData::Language.
*/
/*!
- \fn QMediaStreamsControl::isActive(int stream)
+ \fn QMediaStreamsControl::isActive(int streamNumber)
- Returns true if the media \a stream is active.
+ Returns true if the media stream \a streamNumber is active.
*/
/*!
- \fn QMediaStreamsControl::setActive(int stream, bool state)
+ \fn QMediaStreamsControl::setActive(int streamNumber, bool state)
- Sets the active \a state of a media \a stream.
+ Sets the active \a state of media stream \a streamNumber.
Setting the active state of a media stream to true will activate it. If any other stream
of the same type was previously active it will be deactivated. Setting the active state fo a
diff --git a/src/multimedia/controls/qvideodeviceselectorcontrol.h b/src/multimedia/controls/qvideodeviceselectorcontrol.h
index 2d55c0d70..4697196ce 100644
--- a/src/multimedia/controls/qvideodeviceselectorcontrol.h
+++ b/src/multimedia/controls/qvideodeviceselectorcontrol.h
@@ -67,7 +67,7 @@ public Q_SLOTS:
Q_SIGNALS:
void selectedDeviceChanged(int index);
- void selectedDeviceChanged(const QString &deviceName);
+ void selectedDeviceChanged(const QString &name);
void devicesChanged();
protected:
diff --git a/src/multimedia/controls/qvideoencodersettingscontrol.h b/src/multimedia/controls/qvideoencodersettingscontrol.h
index 366d585ee..8c8213cf5 100644
--- a/src/multimedia/controls/qvideoencodersettingscontrol.h
+++ b/src/multimedia/controls/qvideoencodersettingscontrol.h
@@ -71,7 +71,7 @@ public:
bool *continuous = nullptr) const = 0;
virtual QStringList supportedVideoCodecs() const = 0;
- virtual QString videoCodecDescription(const QString &codecName) const = 0;
+ virtual QString videoCodecDescription(const QString &codec) const = 0;
virtual QVideoEncoderSettings videoSettings() const = 0;
virtual void setVideoSettings(const QVideoEncoderSettings &settings) = 0;
diff --git a/src/multimedia/doc/QtMultimediaDoc b/src/multimedia/doc/QtMultimediaDoc
new file mode 100644
index 000000000..5723c2a78
--- /dev/null
+++ b/src/multimedia/doc/QtMultimediaDoc
@@ -0,0 +1,3 @@
+#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 074fcb75e..aa2aa4e3e 100644
--- a/src/multimedia/doc/qtmultimedia.qdocconf
+++ b/src/multimedia/doc/qtmultimedia.qdocconf
@@ -4,6 +4,9 @@ project = QtMultimedia
description = Qt Multimedia Documentation
version = $QT_VERSION
+moduleheader = QtMultimediaDoc
+includepaths = -I .
+
# The following parameters are for creating a qhp file, the qhelpgenerator
# program can convert the qhp file into a qch file which can be opened in
# Qt Assistant and/or Qt Creator.
diff --git a/src/multimedia/qmediaserviceprovider.cpp b/src/multimedia/qmediaserviceprovider.cpp
index b0783fba6..21e34bd49 100644
--- a/src/multimedia/qmediaserviceprovider.cpp
+++ b/src/multimedia/qmediaserviceprovider.cpp
@@ -708,8 +708,6 @@ QMediaServiceProviderHint::Features QMediaServiceProvider::supportedFeatures(con
}
/*!
- \fn QMultimedia::SupportEstimate QMediaServiceProvider::hasSupport(const QByteArray &serviceType, const QString &mimeType, const QStringList& codecs, int flags) const
-
Returns how confident a media service provider is that is can provide a \a
serviceType service that is able to play media of a specific \a mimeType
that is encoded using the listed \a codecs while adhering to constraints
diff --git a/src/multimedia/qmediatimerange.cpp b/src/multimedia/qmediatimerange.cpp
index 700dcd087..676d3d391 100644
--- a/src/multimedia/qmediatimerange.cpp
+++ b/src/multimedia/qmediatimerange.cpp
@@ -184,7 +184,6 @@ QMediaTimeInterval QMediaTimeInterval::translated(qint64 offset) const
}
/*!
- \fn operator==(const QMediaTimeInterval &a, const QMediaTimeInterval &b)
\relates QMediaTimeRange
Returns true if \a a is exactly equal to \a b.
@@ -195,7 +194,6 @@ bool operator==(const QMediaTimeInterval &a, const QMediaTimeInterval &b)
}
/*!
- \fn operator!=(const QMediaTimeInterval &a, const QMediaTimeInterval &b)
\relates QMediaTimeRange
Returns true if \a a is not exactly equal to \a b.
@@ -396,8 +394,6 @@ QMediaTimeRange::~QMediaTimeRange()
}
/*!
- \fn QMediaTimeRange::operator=(const QMediaTimeRange &other)
-
Takes a copy of the \a other time range and returns itself.
*/
QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &other)
@@ -407,8 +403,6 @@ QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &other)
}
/*!
- \fn QMediaTimeRange::operator=(const QMediaTimeInterval &interval)
-
Sets the time range to a single continuous interval, \a interval.
*/
QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeInterval &interval)
@@ -486,8 +480,6 @@ void QMediaTimeRange::addInterval(const QMediaTimeInterval &interval)
}
/*!
- \fn QMediaTimeRange::addTimeRange(const QMediaTimeRange &range)
-
Adds each of the intervals in \a range to this time range.
Equivalent to calling addInterval() for each interval in \a range.
@@ -536,8 +528,6 @@ void QMediaTimeRange::removeInterval(const QMediaTimeInterval &interval)
}
/*!
- \fn QMediaTimeRange::removeTimeRange(const QMediaTimeRange &range)
-
Removes each of the intervals in \a range from this time range.
Equivalent to calling removeInterval() for each interval in \a range.
@@ -551,8 +541,6 @@ void QMediaTimeRange::removeTimeRange(const QMediaTimeRange &range)
}
/*!
- \fn QMediaTimeRange::operator+=(const QMediaTimeRange &other)
-
Adds each interval in \a other to the time range and returns the result.
*/
QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeRange &other)
@@ -562,8 +550,6 @@ QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeRange &other)
}
/*!
- \fn QMediaTimeRange::operator+=(const QMediaTimeInterval &interval)
-
Adds the specified \a interval to the time range and returns the result.
*/
QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeInterval &interval)
@@ -573,8 +559,6 @@ QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeInterval &interval)
}
/*!
- \fn QMediaTimeRange::operator-=(const QMediaTimeRange &other)
-
Removes each interval in \a other from the time range and returns the result.
*/
QMediaTimeRange& QMediaTimeRange::operator-=(const QMediaTimeRange &other)
@@ -584,8 +568,6 @@ QMediaTimeRange& QMediaTimeRange::operator-=(const QMediaTimeRange &other)
}
/*!
- \fn QMediaTimeRange::operator-=(const QMediaTimeInterval &interval)
-
Removes the specified \a interval from the time range and returns the result.
*/
QMediaTimeRange& QMediaTimeRange::operator-=(const QMediaTimeInterval &interval)
@@ -658,7 +640,6 @@ bool QMediaTimeRange::contains(qint64 time) const
}
/*!
- \fn operator==(const QMediaTimeRange &a, const QMediaTimeRange &b)
\relates QMediaTimeRange
Returns true if all intervals in \a a are present in \a b.
@@ -669,7 +650,6 @@ bool operator==(const QMediaTimeRange &a, const QMediaTimeRange &b)
}
/*!
- \fn operator!=(const QMediaTimeRange &a, const QMediaTimeRange &b)
\relates QMediaTimeRange
Returns true if one or more intervals in \a a are not present in \a b.
@@ -680,7 +660,6 @@ bool operator!=(const QMediaTimeRange &a, const QMediaTimeRange &b)
}
/*!
- \fn operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
\relates QMediaTimeRange
Returns a time range containing the union between \a r1 and \a r2.
@@ -691,7 +670,6 @@ QMediaTimeRange operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
}
/*!
- \fn operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
\relates QMediaTimeRange
Returns a time range containing \a r2 subtracted from \a r1.
diff --git a/src/multimedia/video/qabstractvideosurface.h b/src/multimedia/video/qabstractvideosurface.h
index 391c9e696..c136ba6c1 100644
--- a/src/multimedia/video/qabstractvideosurface.h
+++ b/src/multimedia/video/qabstractvideosurface.h
@@ -68,7 +68,7 @@ public:
~QAbstractVideoSurface();
virtual QList<QVideoFrame::PixelFormat> supportedPixelFormats(
- QAbstractVideoBuffer::HandleType handleType = QAbstractVideoBuffer::NoHandle) const = 0;
+ QAbstractVideoBuffer::HandleType type = QAbstractVideoBuffer::NoHandle) const = 0;
virtual bool isFormatSupported(const QVideoSurfaceFormat &format) const;
virtual QVideoSurfaceFormat nearestFormat(const QVideoSurfaceFormat &format) const;
@@ -89,7 +89,7 @@ Q_SIGNALS:
void activeChanged(bool active);
void surfaceFormatChanged(const QVideoSurfaceFormat &format);
void supportedFormatsChanged();
- void nativeResolutionChanged(const QSize &);
+ void nativeResolutionChanged(const QSize &resolution);
protected:
void setError(Error error);
diff --git a/src/multimedia/video/qvideoprobe.h b/src/multimedia/video/qvideoprobe.h
index 93ba4d2f5..38f5ca05a 100644
--- a/src/multimedia/video/qvideoprobe.h
+++ b/src/multimedia/video/qvideoprobe.h
@@ -62,7 +62,7 @@ public:
bool isActive() const;
Q_SIGNALS:
- void videoFrameProbed(const QVideoFrame &videoFrame);
+ void videoFrameProbed(const QVideoFrame &frame);
void flush();
private:
diff --git a/src/multimedia/video/qvideosurfaceformat.cpp b/src/multimedia/video/qvideosurfaceformat.cpp
index 384ab4e53..7a703c260 100644
--- a/src/multimedia/video/qvideosurfaceformat.cpp
+++ b/src/multimedia/video/qvideosurfaceformat.cpp
@@ -464,7 +464,7 @@ bool QVideoSurfaceFormat::isMirrored() const
}
/*!
- Sets if the surface is mirrored around its vertical axis.
+ Sets if the surface is \a mirrored around its vertical axis.
This is typically needed for video frames coming from a front camera of a mobile device.
Default value is false.
diff --git a/src/multimedia/video/qvideosurfaceformat.h b/src/multimedia/video/qvideosurfaceformat.h
index 175b199a7..1d1990c77 100644
--- a/src/multimedia/video/qvideosurfaceformat.h
+++ b/src/multimedia/video/qvideosurfaceformat.h
@@ -71,7 +71,7 @@ public:
YCbCr_xvYCC601,
YCbCr_xvYCC709,
YCbCr_JPEG,
-#ifndef qdoc
+#ifndef Q_QDOC
YCbCr_CustomMatrix
#endif
};