diff options
| author | Angus Cummings <angus.cummings@nokia.com> | 2012-04-30 16:49:23 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-16 05:21:25 +0200 |
| commit | 9e6d03584a097964e5f08c46cd02338b0b043080 (patch) | |
| tree | d00b2c09412236e387337890bb2260dc2d3741d6 /src/imports/audioengine/qdeclarative_audiosample_p.cpp | |
| parent | fdb5c419c4fb7b1ae0268e496ccdd0ffa03b74ce (diff) | |
Minor doc fixes for QML
renaming QML element to QML type
removing some \fn tags that were making the docs not build
some rewording
some new signal docs
Change-Id: I9b350dad1780276959aef4105e53b91082a6083e
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'src/imports/audioengine/qdeclarative_audiosample_p.cpp')
| -rw-r--r-- | src/imports/audioengine/qdeclarative_audiosample_p.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index 6a33e86a5..fe80989ee 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -52,15 +52,15 @@ QT_USE_NAMESPACE /*! \qmlclass AudioSample QDeclarativeAudioSample \since 5.0 - \brief The AudioSample element allows you to load audio samples, mostly wav file. + \brief The AudioSample type allows you to load audio samples, mostly wav file. \inqmlmodule QtAudioEngine 1 \ingroup multimedia_audioengine \inherits Item \preliminary - This element is part of the \b{QtAudioEngine 1.0} module. + \c AudioSample is part of the \b{QtAudioEngine 1.0} module. - AudioSample element can be accessed through QtAudioEngine1::AudioEngine::samples with its unique + It can be accessed through QtAudioEngine1::AudioEngine::samples with its unique name and must be defined inside AudioEngine. \qml @@ -135,9 +135,9 @@ bool QDeclarativeAudioSample::isStreaming() const /*! \qmlproperty bool QtAudioEngine1::AudioSample::preloaded - This property holds indicates whether this sample needs to be preloaded or not. + 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 untill be used by other element. + otherwise the sample will not be loaded until explicitly requested. */ bool QDeclarativeAudioSample::isPreloaded() const |