summaryrefslogtreecommitdiffstats
path: root/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-18 21:43:08 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 15:57:04 +0100
commit4c0e4e15362c65d52b7f0e8f7a9e9576b45010e8 (patch)
tree313e5c4f905a68a399605688044ff0893b101bde /src/imports/audioengine/qdeclarative_soundinstance_p.cpp
parent04edeafade9058bde6d6dd58e6b1a89bace2fd50 (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/audioengine/qdeclarative_soundinstance_p.cpp')
-rw-r--r--src/imports/audioengine/qdeclarative_soundinstance_p.cpp42
1 files changed, 28 insertions, 14 deletions
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index 9aa5554bf..9f3a0d35d 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -527,43 +527,57 @@ void QDeclarativeSoundInstance::handleStateChanged()
}
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onStateChanged(state)
+ \qmlsignal QtAudioEngine::SoundInstance::stateChanged(state)
- This handler is called when \l state is changed
+ This signal is emitted when \l state is changed
+
+ The corresponding handler is \c onStateChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onPositionChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::positionChanged()
+
+ This signal is emitted when \l position is changed
- This handler is called when \l position is changed
+ The corresponding handler is \c onPositionChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onDirectionChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::directionChanged()
- This handler is called when \l direction is changed
+ This signal is emitted when \l direction is changed
+
+ The corresponding handler is \c onDirectionChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onVelocityChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::velocityChanged()
+
+ This signal is emitted when \l velocity is changed
- This handler is called when \l velocity is changed
+ The corresponding handler is \c onVelocityChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onGainChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::gainChanged()
- This handler is called when \l gain is changed
+ This signal is emitted when \l gain is changed
+
+ The corresponding handler is \c onGainChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onPitchChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::pitchChanged()
+
+ This signal is emitted when \l pitch is changed
- This handler is called when \l pitch is changed
+ The corresponding handler is \c onPitchChanged.
*/
/*!
- \qmlsignal QtAudioEngine::SoundInstance::onSoundChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::soundChanged()
+
+ This signal is emitted when \l sound is changed
- This handler is called when \l sound is changed
+ The corresponding handler is \c onSoundChanged.
*/