summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoann Lopes <yoann.lopes@theqtcompany.com>2015-08-10 16:49:03 +0200
committerYoann Lopes <yoann.lopes@theqtcompany.com>2015-08-11 13:14:28 +0000
commit6df6cacbb0238a7035a4c66fd5df992bda0a99c2 (patch)
tree32de565252405fcd63736592ffea19b38ed7ac4f
parentb8553dae1d5c14c5f2e2ab6e9758e8abe0045cfe (diff)
downloadqtmultimedia-6df6cacbb0238a7035a4c66fd5df992bda0a99c2.tar.gz
Fix qdoc warnings.
Change-Id: Ie351f33f88270186b7df0f9cd671fa4e31624231 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
-rw-r--r--src/imports/multimedia/qdeclarativecameraflash.cpp8
-rw-r--r--src/imports/multimedia/qdeclarativecameraimageprocessing.cpp2
-rw-r--r--src/multimedia/camera/qcamera.cpp13
-rw-r--r--src/multimedia/camera/qcameraimageprocessing.cpp2
-rw-r--r--src/multimedia/camera/qcameraviewfindersettings.cpp12
-rw-r--r--src/multimedia/doc/src/qtmultimedia-index.qdoc12
-rw-r--r--src/multimedia/qmediaserviceprovider.cpp35
-rw-r--r--src/multimedia/video/qabstractvideofilter.cpp12
8 files changed, 70 insertions, 26 deletions
diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp
index 966ef7ee2..030d55160 100644
--- a/src/imports/multimedia/qdeclarativecameraflash.cpp
+++ b/src/imports/multimedia/qdeclarativecameraflash.cpp
@@ -77,11 +77,7 @@ QDeclarativeCameraFlash::QDeclarativeCameraFlash(QCamera *camera, QObject *paren
QDeclarativeCameraFlash::~QDeclarativeCameraFlash()
{
}
-/*!
- \property bool QDeclarativeCameraFlash::ready
- This property indicates whether the flash is charged.
-*/
/*!
\qmlproperty bool QtMultimedia::CameraFlash::ready
@@ -91,11 +87,7 @@ bool QDeclarativeCameraFlash::isFlashReady() const
{
return m_exposure->isFlashReady();
}
-/*!
- \property QDeclarativeCameraFlash::mode
- This property holds the camera flash mode. The mode can be one of the constants in \l QCameraExposure::FlashMode.
-*/
/*!
\qmlproperty enumeration QtMultimedia::CameraFlash::mode
diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
index d31ea7a09..de5aee85b 100644
--- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
+++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
@@ -218,7 +218,7 @@ void QDeclarativeCameraImageProcessing::setDenoisingLevel(qreal value)
}
/*!
- \qmlproperty QtMultimedia::CameraImageProcessing::colorFilter
+ \qmlproperty enumeration QtMultimedia::CameraImageProcessing::colorFilter
This property holds which color filter if any will be applied to image data captured by the camera.
diff --git a/src/multimedia/camera/qcamera.cpp b/src/multimedia/camera/qcamera.cpp
index e70bed047..a5fee2767 100644
--- a/src/multimedia/camera/qcamera.cpp
+++ b/src/multimedia/camera/qcamera.cpp
@@ -1043,6 +1043,19 @@ void QCamera::unlock()
*/
/*!
+ \fn QCamera::FrameRateRange::FrameRateRange()
+
+ Constructs a null frame rate range, with both minimumFrameRate and maximumFrameRate
+ equal to \c 0.0.
+*/
+
+/*!
+ \fn QCamera::FrameRateRange::FrameRateRange(qreal minimum, qreal maximum)
+
+ Constructs a frame rate range with the given \a minimum and \a maximum frame rates.
+*/
+
+/*!
\variable QCamera::FrameRateRange::minimumFrameRate
The minimum frame rate supported by the range, in frames per second.
*/
diff --git a/src/multimedia/camera/qcameraimageprocessing.cpp b/src/multimedia/camera/qcameraimageprocessing.cpp
index 24d53eb7e..4ce3759e4 100644
--- a/src/multimedia/camera/qcameraimageprocessing.cpp
+++ b/src/multimedia/camera/qcameraimageprocessing.cpp
@@ -319,7 +319,7 @@ void QCameraImageProcessing::setDenoisingLevel(qreal level)
*/
/*!
- \enum QCameraImageProcessing::Filter
+ \enum QCameraImageProcessing::ColorFilter
\value ColorFilterNone No filter is applied to images.
\value ColorFilterGrayscale A grayscale filter.
diff --git a/src/multimedia/camera/qcameraviewfindersettings.cpp b/src/multimedia/camera/qcameraviewfindersettings.cpp
index a92ee65ad..df4fa7022 100644
--- a/src/multimedia/camera/qcameraviewfindersettings.cpp
+++ b/src/multimedia/camera/qcameraviewfindersettings.cpp
@@ -135,6 +135,18 @@ QCameraViewfinderSettings &QCameraViewfinderSettings::operator=(const QCameraVie
return *this;
}
+/*! \fn QCameraViewfinderSettings &QCameraViewfinderSettings::operator=(QCameraViewfinderSettings &&other)
+
+ Moves \a other to this viewfinder settings object and returns a reference to this object.
+*/
+
+/*!
+ \fn void QCameraViewfinderSettings::swap(QCameraViewfinderSettings &other)
+
+ Swaps this viewfinder settings object with \a other. This
+ function is very fast and never fails.
+*/
+
/*!
\relates QCameraViewfinderSettings
\since 5.5
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 82dc0b1b2..65fcb210b 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -102,11 +102,17 @@
\li QAudioOutput
\li Sends audio data to an audio output device
\row
+ \li QAudioRecorder
+ \li Record media content from an audio source.
+ \row
\li QCamera
\li Access camera viewfinder.
\row
\li QCameraImageCapture
- \li Record media content. Intended to be used with QCamera to record media.
+ \li Capture still images with a camera.
+ \row
+ \li QMediaRecorder
+ \li Record media content from a camera or radio tuner source.
\row
\li QMediaPlayer
\li Playback media from a source.
@@ -114,8 +120,8 @@
\li QRadioTuner
\li Access radio device.
\row
- \li QVideoRendererControl
- \li Control video data.
+ \li QAbstractVideoSurface
+ \li Base class for video presentation.
\endtable
\section1 Related Information
diff --git a/src/multimedia/qmediaserviceprovider.cpp b/src/multimedia/qmediaserviceprovider.cpp
index 658679c56..c852e3e7c 100644
--- a/src/multimedia/qmediaserviceprovider.cpp
+++ b/src/multimedia/qmediaserviceprovider.cpp
@@ -888,23 +888,38 @@ QMediaServiceProvider *QMediaServiceProvider::defaultServiceProvider()
*/
/*!
- \since 5.3
+ \fn QList<QByteArray> QMediaServiceSupportedDevicesInterface::devices(const QByteArray &service) const
- \fn QByteArray QMediaServiceSupportedDevicesInterface::defaultDevice(const QByteArray &service) const
+ Returns a list of devices available for a \a service type.
+*/
- Returns the default device for a \a service type.
+/*!
+ \fn QString QMediaServiceSupportedDevicesInterface::deviceDescription(const QByteArray &service, const QByteArray &device)
+
+ Returns the description of a \a device available for a \a service type.
*/
/*!
- \fn QList<QByteArray> QMediaServiceSupportedDevicesInterface::devices(const QByteArray &service) const
+ \class QMediaServiceDefaultDeviceInterface
+ \inmodule QtMultimedia
+ \brief The QMediaServiceDefaultDeviceInterface class interface
+ identifies the default device used by a media service plug-in.
- Returns a list of devices available for a \a service type.
+ A QMediaServiceProviderPlugin may implement this interface.
+
+ \since 5.3
*/
/*!
- \fn QString QMediaServiceSupportedDevicesInterface::deviceDescription(const QByteArray &service, const QByteArray &device)
+ \fn QMediaServiceDefaultDeviceInterface::~QMediaServiceDefaultDeviceInterface()
- Returns the description of a \a device available for a \a service type.
+ Destroys a media service default device interface.
+*/
+
+/*!
+ \fn QByteArray QMediaServiceDefaultDeviceInterface::defaultDevice(const QByteArray &service) const
+
+ Returns the default device for a \a service type.
*/
/*!
@@ -919,6 +934,12 @@ QMediaServiceProvider *QMediaServiceProvider::defaultServiceProvider()
*/
/*!
+ \fn QMediaServiceCameraInfoInterface::~QMediaServiceCameraInfoInterface()
+
+ Destroys a media service camera info interface.
+*/
+
+/*!
\fn QMediaServiceCameraInfoInterface::cameraPosition(const QByteArray &device) const
Returns the physical position of a camera \a device supported by a camera service plug-in.
diff --git a/src/multimedia/video/qabstractvideofilter.cpp b/src/multimedia/video/qabstractvideofilter.cpp
index ccfe9ccdd..7d326ddff 100644
--- a/src/multimedia/video/qabstractvideofilter.cpp
+++ b/src/multimedia/video/qabstractvideofilter.cpp
@@ -276,10 +276,13 @@ QAbstractVideoFilter::~QAbstractVideoFilter()
}
/*!
- \return \c true if the filter is active.
+ \property QAbstractVideoFilter::active
+ \brief the active status of the filter.
- By default filters are active. When set to \c false, the filter will be
- ignored by the VideoOutput type.
+ This is true if the filter is active, false otherwise.
+
+ By default filters are active. When set to \c false, the filter will be
+ ignored by the VideoOutput type.
*/
bool QAbstractVideoFilter::isActive() const
{
@@ -287,9 +290,6 @@ bool QAbstractVideoFilter::isActive() const
return d->active;
}
-/*!
- \internal
- */
void QAbstractVideoFilter::setActive(bool v)
{
Q_D(QAbstractVideoFilter);