Fix a number of other qdoc issues.

* Several places needed the forward class declaration hack
* Missing/wrong minor version numbers on imports
* A few typos
* Any number of attempts to work around qdoc
* A few missing docs
* Tweaked soundeffect docs

Change-Id: I3c2ab998a11cbb0956712e0423e01fdb70f5bfff
Reviewed-by: Peter Yard <peter.yard@nokia.com>
Reviewed-by: Angus Cummings <angus.cummings@nokia.com>
Reviewed-by: Jonas Rabbe <jonas.rabbe@gmail.com>
This commit is contained in:
Michael Goddard
2012-06-13 13:52:05 +10:00
committed by Qt by Nokia
parent e975897ad7
commit 6931cbb35a
35 changed files with 611 additions and 436 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -50,12 +50,12 @@ QT_USE_NAMESPACE
/*!
\qmlclass PlayVariation QDeclarativePlayVariation
\since 5.0
\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
AudioSample.
\inqmlmodule QtAudioEngine 1
\inqmlmodule QtAudioEngine 1.0
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

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

View File

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