summaryrefslogtreecommitdiffstats
path: root/src/imports/audioengine
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-06-13 13:52:05 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-15 08:49:29 +0200
commit6931cbb35a909b192960205929d4a0efde280ee2 (patch)
tree84ca34a55756f929d255a887c12c01e69d101259 /src/imports/audioengine
parente975897ad7ebbad12f023e83eae8c4b7840ad6ed (diff)
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>
Diffstat (limited to 'src/imports/audioengine')
-rw-r--r--src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp9
-rw-r--r--src/imports/audioengine/qdeclarative_audiocategory_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_audioengine_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_audiolistener_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_audiosample_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_playvariation_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_sound_p.cpp4
-rw-r--r--src/imports/audioengine/qdeclarative_soundinstance_p.cpp4
8 files changed, 19 insertions, 18 deletions
diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
index e1a4ac004..00521f5f8 100644
--- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
+++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
index 1c78bd8bd..223175a1d 100644
--- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
index 58259e1e9..fa021775d 100644
--- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
index 55ba0b212..91816b038 100644
--- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
index 80b33025e..9c98f2eeb 100644
--- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
index 64bac1e20..3f78ce048 100644
--- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp
+++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp
index ca9ae10ce..22eb4e3a8 100644
--- a/src/imports/audioengine/qdeclarative_sound_p.cpp
+++ b/src/imports/audioengine/qdeclarative_sound_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index 2bdc6a69f..241a79b96 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -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