Doc: Various fixes to Qt Audio Engine documentation

-fixed \since to "\since 5.0" (Qt version 5.0)
-made a \qmlmodule page so the list of related classes are automatically
 listed
-made changes in the Qt Multimedia documentation to link to the
 Qt Audio Engine documentation

Change-Id: Ibdd3da02871648988a73172934e684840c4ce0ae
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
This commit is contained in:
Jerome Pasion
2013-10-02 16:27:06 +02:00
committed by The Qt Project
parent 43be5d9763
commit 3793b0653f
10 changed files with 55 additions and 64 deletions

View File

@@ -92,9 +92,9 @@ void QDeclarativeAttenuationModel::setName(const QString& name)
/*!
\qmltype AttenuationModelLinear
\instantiates QDeclarativeAttenuationModelLinear
\since 1.0
\since 5.0
\brief Defines a linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary
@@ -225,9 +225,9 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene
\qmltype AttenuationModelInverse
\instantiates QDeclarativeAttenuationModelInverse
\since 1.0
\since 5.0
\brief Defines a non-linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -49,9 +49,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioCategory
\instantiates QDeclarativeAudioCategory
\since 1.0
\since 5.0
\brief Control all active sound instances by group.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -58,9 +58,9 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype AudioEngine
\instantiates QDeclarativeAudioEngine
\since 1.0
\since 5.0
\brief Organize all your 3d audio content in one place.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -50,9 +50,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioListener
\instantiates QDeclarativeAudioListener
\since 1.0
\since 5.0
\brief Control global listener parameters.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -52,9 +52,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioSample
\instantiates QDeclarativeAudioSample
\since 1.0
\since 5.0
\brief Load audio samples, mostly .wav.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -51,12 +51,12 @@ QT_USE_NAMESPACE
/*!
\qmltype PlayVariation
\instantiates QDeclarativePlayVariation
\since 1.0
\since 5.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
AudioSample.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -140,10 +140,10 @@ void QDeclarativeSoundCone::componentComplete()
/*!
\qmltype Sound
\instantiates QDeclarativeSound
\since 1.0
\since 5.0
\brief Define a variety of samples and parameters to be used for
SoundInstance.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -53,9 +53,9 @@ QT_USE_NAMESPACE
/*!
\qmltype SoundInstance
\instantiates QDeclarativeSoundInstance
\since 1.0
\since 5.0
\brief Play 3d audio content.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary