From 4c0e4e15362c65d52b7f0e8f7a9e9576b45010e8 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Tue, 18 Mar 2014 21:43:08 +0800 Subject: Doc: Document signals (not handlers) under \qmlsignal MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Append the handler names to the end of the corresponding signal doc. Task-number: QTBUG-35846 Change-Id: I325cdab75ef18a19c9f29d6333039c31baa8daf6 Reviewed-by: Jerome Pasion Reviewed-by: Jędrzej Nowacki --- .../audioengine/qdeclarative_soundinstance_p.cpp | 42 ++++++++++++++-------- 1 file changed, 28 insertions(+), 14 deletions(-) (limited to 'src/imports/audioengine/qdeclarative_soundinstance_p.cpp') 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. */ -- cgit v1.2.3