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>
This commit is contained in:
Jerome Pasion
2012-07-27 14:51:00 +02:00
committed by Qt by Nokia
parent b976589a66
commit 011e151c4e
22 changed files with 47 additions and 24 deletions

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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