diff options
| author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-18 21:43:08 +0800 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-18 15:57:04 +0100 |
| commit | 4c0e4e15362c65d52b7f0e8f7a9e9576b45010e8 (patch) | |
| tree | 313e5c4f905a68a399605688044ff0893b101bde /src/imports/multimedia/qdeclarativeaudio.cpp | |
| parent | 04edeafade9058bde6d6dd58e6b1a89bace2fd50 (diff) | |
Doc: Document signals (not handlers) under \qmlsignal
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>
Diffstat (limited to 'src/imports/multimedia/qdeclarativeaudio.cpp')
| -rw-r--r-- | src/imports/multimedia/qdeclarativeaudio.cpp | 40 |
1 files changed, 30 insertions, 10 deletions
diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp index 4f741616f..3e1543d90 100644 --- a/src/imports/multimedia/qdeclarativeaudio.cpp +++ b/src/imports/multimedia/qdeclarativeaudio.cpp @@ -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. */ /*! |