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/audioengine/qdeclarative_audiosample_p.cpp
View File

@@ -237,9 +237,11 @@ QSoundBuffer* QDeclarativeAudioSample::soundBuffer() const
}
/*!
\qmlsignal QtAudioEngine::AudioSample::onLoadedChanged()
\qmlsignal QtAudioEngine::AudioSample::loadedChanged()
This handler is called when \l loaded is changed
This signal is emitted when \l loaded is changed
The corresponding handler is \c onLoadedChanged.
*/

42
src/imports/audioengine/qdeclarative_soundinstance_p.cpp
View File

@@ -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 handler is called when \l position is changed
This signal is emitted 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 handler is called when \l velocity is changed
This signal is emitted 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 handler is called when \l pitch is changed
This signal is emitted when \l pitch is changed
The corresponding handler is \c onPitchChanged.
*/
/*!
\qmlsignal QtAudioEngine::SoundInstance::onSoundChanged()
\qmlsignal QtAudioEngine::SoundInstance::soundChanged()
This handler is called when \l sound is changed
This signal is emitted when \l sound is changed
The corresponding handler is \c onSoundChanged.
*/