slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated a lot of minor fixes to the docs and removed warnings from qdoc

Browse Source 
Change-Id: Ib7fd75fb93c038f9e8fa9d71b6ad01fb27b97622
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
Jonas Rabbe
2012-04-03 15:55:55 +10:00
committed by Qt by Nokia
parent e908790a6a
commit c532850fd1
68 changed files with 476 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/multimedia/controls/qaudiodecodercontrol_p.cpp
View File

@@ -215,7 +215,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
*/
/*!
\fn QAudioDecoderControl::audioFormat()
\fn QAudioDecoderControl::audioFormat() const
Returns the current audio format of the decoded stream.
Any buffers returned should have this format.
@@ -244,13 +244,13 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
*/
/*!
\fn QAudioDecoderControl::position()
\fn QAudioDecoderControl::position() const
Returns position (in milliseconds) of the last buffer read from
the decoder or -1 if no buffers have been read.
*/
/*!
\fn QAudioDecoderControl::duration()
\fn QAudioDecoderControl::duration() const
Returns total duration (in milliseconds) of the audio stream
or -1 if not available.
*/

2
src/multimedia/controls/qcameracapturedestinationcontrol.cpp
View File

@@ -96,7 +96,7 @@ QCameraCaptureDestinationControl::~QCameraCaptureDestinationControl()
/*!
\fn QCameraCaptureDestinationControl::captureDestination() const
Returns the current capture \a destination. The default destination is QCameraImageCapture::CaptureToFile.
Returns the current capture destination. The default destination is QCameraImageCapture::CaptureToFile.
*/
/*!

6
src/multimedia/controls/qcamerafeedbackcontrol.cpp
View File

@@ -139,7 +139,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
*/
/*!
\fn bool QCameraFeedbackControl::setEventFeedbackEnabled(EventType event, bool enabled) const
\fn bool QCameraFeedbackControl::setEventFeedbackEnabled(EventType event, bool enabled)
Turns on feedback for the specific \a event if \a enabled is true, otherwise disables the
feedback. Returns true if the feedback could be modified, or false otherwise (e.g. this feedback
@@ -150,7 +150,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
/*!
\fn void QCameraFeedbackControl::resetEventFeedback(EventType event) const
\fn void QCameraFeedbackControl::resetEventFeedback(EventType event)
Restores the feedback setting for this \a event to its default setting.
@@ -158,7 +158,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
*/
/*!
\fn bool setEventFeedbackSound(EventType event, const QString &filePath)
\fn bool QCameraFeedbackControl::setEventFeedbackSound(EventType event, const QString &filePath)
When the given \a event occurs, the sound effect referenced by \a filePath
will be played instead of the default sound.

12
src/multimedia/controls/qcamerafocuscontrol.cpp
View File

@@ -169,27 +169,27 @@ QCameraFocusControl::~QCameraFocusControl()
/*!
\fn void QCameraFocusControl::focusModeChanged(QCameraFocus::FocusModes mode)
Signal is emitted when the focus mode is chaged,
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()
*/
/*!
\fn void QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)
Signal is emitted when the focus point mode is chaged,
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()
*/
/*!
\fn void QCameraFocusControl::customFocusPointChanged(const QPointF &point)
Signal is emitted when the custom focus point is changed.
Signal is emitted when the custom focus \a point is changed.
\sa QCameraFocusControl::customFocusPoint QCameraFocusControl::setCustomFocusPoint
\sa QCameraFocusControl::customFocusPoint() QCameraFocusControl::setCustomFocusPoint()
*/

4
src/multimedia/controls/qcameraimagecapturecontrol.cpp
View File

@@ -150,7 +150,9 @@ QCameraImageCaptureControl::~QCameraImageCaptureControl()
/*!
\fn QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
Signals that a metadata for an image with request \a id is available.
Signals that a metadata for an image with request \a id is available. Signal
also contains the \a key and \a value of the metadata.
This signal should be emitted between imageExposed and imageSaved signals.
*/

2
src/multimedia/controls/qmediaaudioprobecontrol.cpp
View File

@@ -88,7 +88,7 @@ QMediaAudioProbeControl::~QMediaAudioProbeControl()
/*!
\fn QMediaAudioProbeControl::audioBufferProbed(const QAudioBuffer &buffer)
This signal should be emitted when an audio buffer is processed in the
This signal should be emitted when an audio \a buffer is processed in the
media service.
*/

10
src/multimedia/controls/qmediagaplessplaybackcontrol.cpp
View File

@@ -99,13 +99,13 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
/*!
\fn QMediaGaplessPlaybackControl::setNextMedia(const QMediaContent& media)
Sets the next media for smooth transition.
Sets the next \a media for smooth transition.
*/
/*!
\fn QMediaGaplessPlaybackControl::nextMediaChanged(const QMediaContent& media)
Signals that the next media has changed (either explicitly via \l setNextMedia() or when the
Signals that the next \a media has changed (either explicitly via \l setNextMedia() or when the
player clears the next media while advancing to it).
\sa nextMedia()
@@ -123,7 +123,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
\fn QMediaGaplessPlaybackControl::isCrossfadeSupported() const
Indicates whether crossfading is supported or not.
If crossfading is not supported, \l setCrossfadTime() will be ignored and \l crossfadeTime() will
If crossfading is not supported, \l setCrossfadeTime() will be ignored and \l crossfadeTime() will
always return 0.
*/
@@ -131,7 +131,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
/*!
\fn QMediaGaplessPlaybackControl::setCrossfadeTime(qreal crossfadeTime)
Sets the crossfade time in seconds for smooth transition.
Sets the \a crossfadeTime in seconds for smooth transition.
Positive value means how much time it will take for the next media to transit from silent to
full volume and vice versa for current one. So both current and the next one will be playing
@@ -151,7 +151,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
/*!
\fn QMediaGaplessPlaybackControl::crossfadeTimeChanged(qreal crossfadeTime)
Signals that the crossfade time has changed.
Signals that the \a crossfadeTime has changed.
\sa crossfadeTime()
*/

5
src/multimedia/controls/qmedianetworkaccesscontrol.cpp
View File

@@ -59,6 +59,9 @@ QT_BEGIN_NAMESPACE
usage by the supported QMediaObject.
*/
/*!
\internal
*/
QMediaNetworkAccessControl::QMediaNetworkAccessControl(QObject *parent) :
QMediaControl(parent)
{
@@ -81,7 +84,7 @@ QMediaNetworkAccessControl::~QMediaNetworkAccessControl()
and replaced with the new list.
*/
/*
/*!
\fn QNetworkConfiguration QMediaNetworkAccessControl::currentConfiguration() const
Returns the current active configuration in use.

2
src/multimedia/controls/qmediavideoprobecontrol.cpp
View File

@@ -88,7 +88,7 @@ QMediaVideoProbeControl::~QMediaVideoProbeControl()
/*!
\fn QMediaVideoProbeControl::videoFrameProbed(const QVideoFrame &frame)
This signal should be emitted when a video frame is processed in the
This signal should be emitted when a video \a frame is processed in the
media service.
*/

6
src/multimedia/controls/qradiodatacontrol.cpp
View File

@@ -153,6 +153,12 @@ QRadioDataControl::~QRadioDataControl()
Returns true if Alternative Frequency is currently enabled
*/
/*!
\fn QRadioDataControl::alternativeFrequenciesEnabledChanged(bool enabled)
Signals that the alternative frequencies setting has changed to the value of \a enabled.
*/
/*!
\fn void QRadioDataControl::stationIdChanged(QString stationId)

9
src/multimedia/controls/qradiotunercontrol.cpp
View File

@@ -243,9 +243,10 @@ QRadioTunerControl::~QRadioTunerControl()
*/
/*!
\fn void QRadioTunerControl::searchAllStations()
\fn void QRadioTunerControl::searchAllStations(QRadioTuner::SearchMode searchMode)
Starts a scan through the whole frequency band searching all stations
Starts a scan through the whole frequency band searching all stations with a
specific \a searchMode.
*/
/*!
@@ -328,9 +329,9 @@ QRadioTunerControl::~QRadioTunerControl()
*/
/*!
\fn void QRadioTunerControl::stationFound(int frequency)
\fn void QRadioTunerControl::stationFound(int frequency, QString stationId)
Signals that new station with \a frequency was found when scanning
Signals that new station with \a frequency and \a stationId was found when scanning
*/
/*!