diff options
author | Jerome Pasion <jerome.pasion@nokia.com> | 2012-07-27 14:51:00 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-07-27 14:56:32 +0200 |
commit | 011e151c4e010793a004303c67e0df1aa002dfe2 (patch) | |
tree | 4b5cf21f646ccc630829318c4c3f91c3e261d5e2 /src/imports/audioengine | |
parent | b976589a66eafc7b69195a690210fe1d02bb141e (diff) |
Doc: Changed \qmlclass to \qmltype and added \instantiates
-New qdoc command \qmltype replaces \qmlclass
-\instantiates <C++ class> for determining if the QML type has a C++
implementation
Change-Id: I83d1e2c3f376f96ea51afedadf88c3cf478e33d8
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/imports/audioengine')
8 files changed, 18 insertions, 9 deletions
diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp index 00521f5f8..5fba40b9a 100644 --- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp +++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp @@ -90,7 +90,8 @@ void QDeclarativeAttenuationModel::setName(const QString& name) ////////////////////////////////////////////////////////////////////////////////////////// /*! - \qmlclass AttenuationModelLinear QDeclarativeAttenuationModelLinear + \qmltype AttenuationModelLinear + \instantiates QDeclarativeAttenuationModelLinear \since 1.0 \brief Defines a linear attenuation curve for a \l Sound. \inqmlmodule QtAudioEngine 1.0 @@ -221,7 +222,8 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene ////////////////////////////////////////////////////////////////////////////////////////// /*! - \qmlclass AttenuationModelInverse QDeclarativeAttenuationModelInverse + \qmltype AttenuationModelInverse + \instantiates QDeclarativeAttenuationModelInverse \since 1.0 \brief Defines a non-linear attenuation curve for a \l Sound. diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp index 223175a1d..d74790ed1 100644 --- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp @@ -47,7 +47,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioCategory QDeclarativeAudioCategory + \qmltype AudioCategory + \instantiates QDeclarativeAudioCategory \since 1.0 \brief Control all active sound instances by group. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp index 1275523ac..9e2fe7107 100644 --- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp +++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp @@ -56,7 +56,8 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass AudioEngine QDeclarativeAudioEngine + \qmltype AudioEngine + \instantiates QDeclarativeAudioEngine \since 1.0 \brief Organize all your 3d audio content in one place. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp index 91816b038..5f22fc640 100644 --- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp @@ -48,7 +48,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioListener QDeclarativeAudioListener + \qmltype AudioListener + \instantiates QDeclarativeAudioListener \since 1.0 \brief Control global listener parameters. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index c645bb1b8..4694af399 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -50,7 +50,8 @@ QT_USE_NAMESPACE /*! - \qmlclass AudioSample QDeclarativeAudioSample + \qmltype AudioSample + \instantiates QDeclarativeAudioSample \since 1.0 \brief Load audio samples, mostly .wav. \inqmlmodule QtAudioEngine 1.0 diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp index 3f78ce048..aae4120b7 100644 --- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp +++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp @@ -49,7 +49,8 @@ QT_USE_NAMESPACE /*! - \qmlclass PlayVariation QDeclarativePlayVariation + \qmltype PlayVariation + \instantiates QDeclarativePlayVariation \since 1.0 \brief Define a playback variation for \l {Sound} {sounds}. So each time the playback of the same sound can be a slightly different even with the same diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp index 22eb4e3a8..5f3a5a143 100644 --- a/src/imports/audioengine/qdeclarative_sound_p.cpp +++ b/src/imports/audioengine/qdeclarative_sound_p.cpp @@ -138,7 +138,8 @@ void QDeclarativeSoundCone::componentComplete() //////////////////////////////////////////////////////////// /*! - \qmlclass Sound QDeclarativeSound + \qmltype Sound + \instantiates QDeclarativeSound \since 1.0 \brief Define a variety of samples and parameters to be used for SoundInstance. diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp index 241a79b96..06769a71e 100644 --- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp +++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp @@ -51,7 +51,8 @@ QT_USE_NAMESPACE /*! - \qmlclass SoundInstance QDeclarativeSoundInstance + \qmltype SoundInstance + \instantiates QDeclarativeSoundInstance \since 1.0 \brief Play 3d audio content. \inqmlmodule QtAudioEngine 1.0 |