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

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.
*/
/*!