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_audiocategory_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_audiocategory_p.cpp')
| -rw-r--r-- | src/imports/audioengine/qdeclarative_audiocategory_p.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp index e34541728..1c78bd8bd 100644 --- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp @@ -49,15 +49,15 @@ QT_USE_NAMESPACE /*! \qmlclass AudioCategory QDeclarativeAudioCategory \since 5.0 - \brief The AudioCategory element allows you to control all active sound instances by group + \brief Control all active sound instances by group. \inqmlmodule QtAudioEngine 1 \ingroup multimedia_audioengine \inherits Item \preliminary - This element is part of the \b{QtAudioEngine 1.0} module. + This type is part of the \b{QtAudioEngine 1.0} module. - AudioCategory element can be accessed through QtAudioEngine1::AudioEngine::categories with its + An instance of AudioCategory can be accessed through QtAudioEngine1::AudioEngine::categories with its unique name and must be defined inside AudioEngine. \qml @@ -100,11 +100,11 @@ QT_USE_NAMESPACE } \endqml - Sound elements can be grouped togather by specifying the category property. When you change the - volume of a category, all audio output from related elements will be affected as well. + \l Sound instances can be grouped together by specifying the category property. When you change the + volume of a category, all audio output from related instances will be affected as well. Note: there will always be an AudioCategory named \c default whether you explicitly define it or - not. If you do not specify any category for a Sound element, it will be grouped into the \c default + not. If you do not specify any category for a \l Sound, it will be grouped into the \c default category. */ @@ -140,7 +140,7 @@ void QDeclarativeAudioCategory::componentComplete() \qmlproperty real QtAudioEngine1::AudioCategory::volume This property holds the volume of the category and will modulate all audio output from the - element which belongs to this category. + instances which belong to this category. */ qreal QDeclarativeAudioCategory::volume() const { @@ -162,7 +162,7 @@ void QDeclarativeAudioCategory::setVolume(qreal volume) \qmlproperty string QtAudioEngine1::AudioCategory::name This property holds the name of AudioCategory. The name must be unique among all categories and only - defined once. + defined once. The name cannot be changed after the instance has been initialized. */ void QDeclarativeAudioCategory::setName(const QString& name) { |