diff options
| author | Mitch Curtis <mitch.curtis@digia.com> | 2014-03-19 10:00:13 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-19 12:48:30 +0100 |
| commit | 19ce431f9feec52327d902ab7005db5aff655535 (patch) | |
| tree | deb63d332694d942cccae26f5aec98dfc6e60887 /src/imports/audioengine/qdeclarative_audiosample_p.cpp | |
| parent | 73de758274f874ad92cd891717a58807a288b4d4 (diff) | |
Tidy up Audio documentation.
Change-Id: I864ba13375d7b8b035686c11687e76fbf672c431
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Diffstat (limited to 'src/imports/audioengine/qdeclarative_audiosample_p.cpp')
| -rw-r--r-- | src/imports/audioengine/qdeclarative_audiosample_p.cpp | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index ee093e97b..a29f0f46e 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -137,8 +137,9 @@ bool QDeclarativeAudioSample::isStreaming() const \qmlproperty bool QtAudioEngine::AudioSample::preloaded This property indicates whether this sample needs to be preloaded or not. - If true, the audio engine will start loading the sample file immediately when the app started, - otherwise the sample will not be loaded until explicitly requested. + If \c true, the audio engine will start loading the sample file immediately + when the application starts, otherwise the sample will not be loaded until + explicitly requested. */ bool QDeclarativeAudioSample::isPreloaded() const @@ -195,8 +196,8 @@ void QDeclarativeAudioSample::setStreaming(bool streaming) /*! \qmlproperty string QtAudioEngine::AudioSample::name - This property holds the name of AudioSample, must be unique among all samples and only - defined once. + This property holds the name of the sample, which must be unique among all + samples and only defined once. */ QString QDeclarativeAudioSample::name() const { @@ -239,7 +240,7 @@ QSoundBuffer* QDeclarativeAudioSample::soundBuffer() const /*! \qmlsignal QtAudioEngine::AudioSample::loadedChanged() - This signal is emitted when \l loaded is changed + This signal is emitted when \l loaded is changed. The corresponding handler is \c onLoadedChanged. */ |