diff options
author | Michael Goddard <michael.goddard@nokia.com> | 2012-04-10 20:19:34 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-04-11 03:31:52 +0200 |
commit | 8484b0ff9c40fe70cdfc17bf74b0a5be93d674de (patch) | |
tree | 2ba877c627c1279fd0e558dc736c8fdec4440906 /src/multimedia/controls | |
parent | 9b162f98440c00dcc0ee4d3b80970a9dc8dc766c (diff) | |
download | qtmultimedia-8484b0ff9c40fe70cdfc17bf74b0a5be93d674de.tar.gz |
Fix a number of doc errors and warnings.
* Document a few missing classes/functions/methods
* Fix a number of QML snippets that wouldn't work as standalone snippets
* Add files to .pro so they show up in Creator..
Still the mysterious lack of controls dir documentation persists :/
Change-Id: I57162371a4d966e4db5bdb1b71d1baf9c0ca57c3
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
Diffstat (limited to 'src/multimedia/controls')
-rw-r--r-- | src/multimedia/controls/qaudiodecodercontrol_p.cpp | 19 | ||||
-rw-r--r-- | src/multimedia/controls/qcameraexposurecontrol.cpp | 18 | ||||
-rw-r--r-- | src/multimedia/controls/qcamerafocuscontrol.cpp | 6 | ||||
-rw-r--r-- | src/multimedia/controls/qvideorenderercontrol.h | 5 |
4 files changed, 24 insertions, 24 deletions
diff --git a/src/multimedia/controls/qaudiodecodercontrol_p.cpp b/src/multimedia/controls/qaudiodecodercontrol_p.cpp index a6c178b17..d2e1c7e4f 100644 --- a/src/multimedia/controls/qaudiodecodercontrol_p.cpp +++ b/src/multimedia/controls/qaudiodecodercontrol_p.cpp @@ -174,6 +174,15 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): */ /*! + \fn QAudioDecoderControl::bufferAvailable() const + + Returns true if a buffer is available to be read, + and false otherwise. If there is no buffer available, calling + the \l read() function may block until a buffer is available or + the end of the media is reached +*/ + +/*! \fn QAudioDecoderControl::sourceChanged() Signals that the current source of the decoder has changed. @@ -186,7 +195,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): Signals that the current audio format of the decoder has changed to \a format. - \sa audioFormat(), setAudioFormat + \sa audioFormat(), setAudioFormat() */ /*! @@ -195,7 +204,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): Signals that the decoding has finished successfully. If decoding fails, error signal is emitted instead. - \sa start(), stop(), error + \sa start(), stop(), error() */ /*! @@ -203,7 +212,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): Signals that the current \a position of the decoder has changed. - \sa durationChanged + \sa durationChanged() */ /*! @@ -211,7 +220,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): Signals that the estimated \a duration of the decoded data has changed. - \sa positionChanged + \sa positionChanged() */ /*! @@ -220,7 +229,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): Any buffers returned should have this format. - \sa setAudioFormat, audioFormatChanged + \sa setAudioFormat(), formatChanged() */ /*! diff --git a/src/multimedia/controls/qcameraexposurecontrol.cpp b/src/multimedia/controls/qcameraexposurecontrol.cpp index 5b4572dca..b36c9f474 100644 --- a/src/multimedia/controls/qcameraexposurecontrol.cpp +++ b/src/multimedia/controls/qcameraexposurecontrol.cpp @@ -53,22 +53,18 @@ QT_BEGIN_NAMESPACE \ingroup multimedia \ingroup multimedia_control - You can adjust a number of parameters that will affect images and video taken with - the corresponding QCamera object. - - There are a number of different parameters that can be adjusted, including: + The QCameraExposure class is the usual method of adjusting exposure related parameters + when using camera functionality. This class provides a more complete but less easy + to use interface, and also forms the interface to implement when writing a new + implementation of QCamera functionality. - \table - \row - \header - \ - - \endtable + You can adjust a number of parameters that will affect images and video taken with + the corresponding QCamera object - see the \l {QCameraExposureControl::ExposureParameter}{ExposureParameter} enumeration. The interface name of QCameraExposureControl is \c org.qt-project.qt.cameraexposurecontrol/5.0 as defined in QCameraExposureControl_iid. - \sa QCamera + \sa QCameraExposure, QCamera */ /*! diff --git a/src/multimedia/controls/qcamerafocuscontrol.cpp b/src/multimedia/controls/qcamerafocuscontrol.cpp index 6f5b0598c..38276daf8 100644 --- a/src/multimedia/controls/qcamerafocuscontrol.cpp +++ b/src/multimedia/controls/qcamerafocuscontrol.cpp @@ -172,7 +172,7 @@ QCameraFocusControl::~QCameraFocusControl() Signal is emitted when the focus \a mode is changed, usually in result of QCameraFocusControl::setFocusMode call or capture mode changes. - \sa QCameraFocusControl::focusMode() QCameraFocusControl::setFocusMode() + \sa QCameraFocusControl::focusMode(), QCameraFocusControl::setFocusMode() */ /*! @@ -181,7 +181,7 @@ QCameraFocusControl::~QCameraFocusControl() Signal is emitted when the focus point \a mode is changed, usually in result of QCameraFocusControl::setFocusPointMode call or capture mode changes. - \sa QCameraFocusControl::focusPointMode() QCameraFocusControl::setFocusPointMode() + \sa QCameraFocusControl::focusPointMode(), QCameraFocusControl::setFocusPointMode() */ /*! @@ -189,7 +189,7 @@ QCameraFocusControl::~QCameraFocusControl() Signal is emitted when the custom focus \a point is changed. - \sa QCameraFocusControl::customFocusPoint() QCameraFocusControl::setCustomFocusPoint() + \sa QCameraFocusControl::customFocusPoint(), QCameraFocusControl::setCustomFocusPoint() */ diff --git a/src/multimedia/controls/qvideorenderercontrol.h b/src/multimedia/controls/qvideorenderercontrol.h index c93117d6c..34d6b6eb7 100644 --- a/src/multimedia/controls/qvideorenderercontrol.h +++ b/src/multimedia/controls/qvideorenderercontrol.h @@ -51,11 +51,6 @@ QT_BEGIN_NAMESPACE QT_MODULE(Multimedia) class QAbstractVideoSurface; -QT_END_NAMESPACE - -QT_BEGIN_NAMESPACE - - class Q_MULTIMEDIA_EXPORT QVideoRendererControl : public QMediaControl { Q_OBJECT |