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

Doc: Document signals (not handlers) under \qmlsignal

Browse Source 
Append the handler names to the end of the corresponding signal doc.

Task-number: QTBUG-35846
Change-Id: I325cdab75ef18a19c9f29d6333039c31baa8daf6
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
This commit is contained in:
Sze Howe Koh
2014-03-18 21:43:08 +08:00
committed by The Qt Project
parent 04edeafade
commit 4c0e4e1536
9 changed files with 124 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/imports/multimedia/Video.qml
View File

@@ -328,6 +328,8 @@ Item {
\qmlsignal Video::paused()
This signal is emitted when playback is paused.
The corresponding handler is \c onPaused.
*/
signal paused
@@ -335,6 +337,8 @@ Item {
\qmlsignal Video::stopped()
This signal is emitted when playback is stopped.
The corresponding handler is \c onStopped.
*/
signal stopped
@@ -342,6 +346,8 @@ Item {
\qmlsignal Video::playing()
This signal is emitted when playback is started or continued.
The corresponding handler is \c onPlaying.
*/
signal playing

40
src/imports/multimedia/qdeclarativeaudio.cpp
View File

@@ -463,26 +463,34 @@ void QDeclarativeAudio::seek(int position)
/*!
\qmlsignal QtMultimedia::Audio::playbackStateChanged()
This handler is called when the \l playbackState property is altered.
This signal is emitted when the \l playbackState property is altered.
The corresponding handler is \c onPlaybackStateChanged.
*/
/*!
\qmlsignal QtMultimedia::Audio::paused()
This handler is called when playback is paused.
This signal is emitted when playback is paused.
The corresponding handler is \c onPaused.
*/
/*!
\qmlsignal QtMultimedia::Audio::stopped()
This handler is called when playback is stopped.
This signal is emitted when playback is stopped.
The corresponding handler is \c onStopped.
*/
/*!
\qmlsignal QtMultimedia::Audio::playing()
This handler is called when playback is started or resumed.
This signal is emitted when playback is started or resumed.
The corresponding handler is \c onPlaying.
*/
/*!
@@ -760,9 +768,11 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlsignal QtMultimedia::Audio::error(error, errorString)
This handler is called when an \l {QMediaPlayer::Error}{error} has
This signal is emitted when an \l {QMediaPlayer::Error}{error} has
occurred. The errorString parameter may contain more detailed
information about the error.
The corresponding handler is \c onError.
*/
/*!
@@ -1267,26 +1277,34 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlsignal QtMultimedia::MediaPlayer::playbackStateChanged()
This handler is called when the \l playbackState property is altered.
This signal is emitted when the \l playbackState property is altered.
The corresponding handler is \c onPlaybackStateChanged.
*/
/*!
\qmlsignal QtMultimedia::MediaPlayer::paused()
This handler is called when playback is paused.
This signal is emitted when playback is paused.
The corresponding handler is \c onPaused.
*/
/*!
\qmlsignal QtMultimedia::MediaPlayer::stopped()
This handler is called when playback is stopped.
This signal is emitted when playback is stopped.
The corresponding handler is \c onStopped.
*/
/*!
\qmlsignal QtMultimedia::MediaPlayer::playing()
This handler is called when playback is started or resumed.
This signal is emitted when playback is started or resumed.
The corresponding handler is \c onPlaying.
*/
/*!
@@ -1440,9 +1458,11 @@ void QDeclarativeAudio::_q_statusChanged()
/*!
\qmlsignal QtMultimedia::MediaPlayer::error(error, errorString)
This handler is called when an \l {QMediaPlayer::Error}{error} has
This signal is emitted when an \l {QMediaPlayer::Error}{error} has
occurred. The errorString parameter may contain more detailed
information about the error.
The corresponding handler is \c onError.
*/
/*!

40
src/imports/multimedia/qdeclarativecamera.cpp
View File

@@ -227,7 +227,7 @@ QDeclarativeCamera::Error QDeclarativeCamera::errorCode() const
This property holds the last error string, if any.
\sa QtMultimedia::Camera::onError
\sa error, errorCode
*/
QString QDeclarativeCamera::errorString() const
{
@@ -594,13 +594,13 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
This property holds the last error code.
\sa QtMultimedia::Camera::onError
\sa error, errorString
*/
/*!
\qmlsignal QtMultimedia::Camera::onError(errorCode, errorString)
\qmlsignal QtMultimedia::Camera::error(errorCode, errorString)
This handler is called when an error occurs. The enumeration value
This signal is emitted when an error occurs. The enumeration value
\a errorCode is one of the values defined below, and a descriptive string
value is available in \a errorString.
@@ -612,6 +612,10 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
\row \li ServiceMissingError \li No camera service available.
\row \li NotSupportedFeatureError \li The feature is not supported.
\endtable
The corresponding handler is \c onError.
\sa errorCode, errorString
*/
/*!
@@ -619,6 +623,8 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
This signal is emitted when the lock status (focus, exposure etc) changes.
This can happen when locking (e.g. autofocusing) is complete or has failed.
The corresponding handler is \c onLockStatusChanged.
*/
/*!
@@ -627,34 +633,44 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
This signal is emitted when the camera state has changed to \a state. Since the
state changes may take some time to occur this signal may arrive sometime
after the state change has been requested.
The corresponding handler is \c onStateChanged.
*/
/*!
\qmlsignal Camera::opticalZoomChanged(zoom)
The optical zoom setting has changed to \a zoom.
This signal is emitted when the optical zoom setting has changed to \a zoom.
The corresponding handler is \c onOpticalZoomChanged.
*/
/*!
\qmlsignal Camera::digitalZoomChanged(zoom)
The digital zoom setting has changed to \a zoom.
This signal is emitted when the digital zoom setting has changed to \a zoom.
The corresponding handler is \c onDigitalZoomChanged.
*/
/*!
\qmlsignal Camera::maximumOpticalZoomChanged(zoom)
The maximum optical zoom setting has changed to \a zoom. This
can occur when you change between video and still image capture
modes, or the capture settings are changed.
This signal is emitted when the maximum optical zoom setting has
changed to \a zoom. This can occur when you change between video
and still image capture modes, or the capture settings are changed.
The corresponding handler is \c onMaximumOpticalZoomChanged.
*/
/*!
\qmlsignal Camera::maximumDigitalZoomChanged(zoom)
The maximum digital zoom setting has changed to \a zoom. This
can occur when you change between video and still image capture
modes, or the capture settings are changed.
This signal is emitted when the maximum digital zoom setting has
changed to \a zoom. This can occur when you change between video
and still image capture modes, or the capture settings are changed.
The corresponding handler is \c onMaximumDigitalZoomChanged.
*/
QT_END_NAMESPACE

34
src/imports/multimedia/qdeclarativecameracapture.cpp
View File

@@ -156,7 +156,7 @@ bool QDeclarativeCameraCapture::isReadyForCapture() const
/*!
\qmlmethod QtMultimedia::CameraCapture::capture()
Start image capture. The \l onImageCaptured() and \l onImageSaved() signals will
Start image capture. The \l imageCaptured and \l imageSaved signals will
be emitted when the capture is complete.
The image will be captured to the default system location, typically
@@ -179,7 +179,7 @@ int QDeclarativeCameraCapture::capture()
/*!
\qmlmethod QtMultimedia::CameraCapture::captureToLocation(location)
Start image capture to specified \a location. The \l onImageCaptured() and \l onImageSaved() signals will
Start image capture to specified \a location. The \l imageCaptured and \l imageSaved signals will
be emitted when the capture is complete.
CameraCapture::captureToLocation returns the capture requestId parameter, used with
@@ -310,39 +310,47 @@ void QDeclarativeCameraCapture::setMetadata(const QString &key, const QVariant &
}
/*!
\qmlsignal QtMultimedia::CameraCapture::onCaptureFailed(requestId, message)
\qmlsignal QtMultimedia::CameraCapture::captureFailed(requestId, message)
This handler is called when an error occurs during capture with \a requestId.
This signal is emitted when an error occurs during capture with \a requestId.
A descriptive message is available in \a message.
The corresponding handler is \c onCaptureFailed.
*/
/*!
\qmlsignal QtMultimedia::CameraCapture::onImageCaptured(requestId, preview)
\qmlsignal QtMultimedia::CameraCapture::imageCaptured(requestId, preview)
This handler is called when an image with \a requestId has been captured
This signal is emitted when an image with \a requestId has been captured
but not yet saved to the filesystem. The \a preview
parameter can be used as the URL supplied to an \l Image.
\sa onImageSaved
The corresponding handler is \c onImageCaptured.
\sa imageSaved
*/
/*!
\qmlsignal QtMultimedia::CameraCapture::onImageSaved(requestId, path)
\qmlsignal QtMultimedia::CameraCapture::imageSaved(requestId, path)
This handler is called after the image with \a requestId has been written to the filesystem.
This signal is emitted after the image with \a requestId has been written to the filesystem.
The \a path is a local file path, not a URL.
\sa onImageCaptured
The corresponding handler is \c onImageSaved.
\sa imageCaptured
*/
/*!
\qmlsignal QtMultimedia::CameraCapture::onImageMetadataAvailable(requestId, key, value)
\qmlsignal QtMultimedia::CameraCapture::imageMetadataAvailable(requestId, key, value)
This handler is called when the image with \a requestId has new metadata
This signal is emitted when the image with \a requestId has new metadata
available with the key \a key and value \a value.
\sa onImageCaptured
The corresponding handler is \c onImageMetadataAvailable.
\sa imageCaptured
*/

2
src/imports/multimedia/qdeclarativecameraflash.cpp
View File

@@ -154,7 +154,7 @@ void QDeclarativeCameraFlash::setFlashMode(int mode)
\qmlsignal QtMultimedia::CameraFlash::flashReady(bool)
This signal is emitted when QCameraExposure indicates that
the flash is ready to use.
The corresponsing handler is \c onFlashReadyChanged.
The corresponding handler is \c onFlashReadyChanged.
*/
QT_END_NAMESPACE

4
src/imports/multimedia/qdeclarativecameraimageprocessing.cpp
View File

@@ -230,11 +230,15 @@ void QDeclarativeCameraImageProcessing::setDenoisingLevel(qreal value)
/*!
\qmlsignal QtMultimedia::Camera::whiteBalanceModeChanged(Camera::WhiteBalanceMode)
This signal is emitted when the \c whiteBalanceMode property is changed.
The corresponding handler is \c onWhiteBalanceModeChanged.
*/
/*!
\qmlsignal QtMultimedia::Camera::manualWhiteBalanceChanged(qreal)
This signal is emitted when the \c manualWhiteBalance property is changed.
The corresponding handler is \c onManualWhiteBalanceChanged.
*/
QT_END_NAMESPACE

2
src/imports/multimedia/qdeclarativeradio.cpp
View File

@@ -540,6 +540,8 @@ void QDeclarativeRadio::_q_availabilityChanged(QMultimedia::AvailabilityStatus a
The \a frequency is returned in Hertz, and the \a stationId corresponds to the station Id
in the \l RadioData for this radio station.
The corresponding handler is \c onStationFound.
*/
QT_END_NAMESPACE