summaryrefslogtreecommitdiff
path: root/src/imports/audioengine
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:27:06 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-03 10:54:17 +0200
commit3793b0653f4127e8f84808419b05115a66c3bc03 (patch)
tree5b76d644393791ac555595ae162d66b3544328cb /src/imports/audioengine
parent43be5d9763eea0b7a71c627f05ffb5de0b97249f (diff)
downloadqtmultimedia-3793b0653f4127e8f84808419b05115a66c3bc03.tar.gz
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>
Diffstat (limited to 'src/imports/audioengine')
-rw-r--r--src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp8
-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, 18 insertions, 18 deletions
diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
index 4787389db..4456f175b 100644
--- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
+++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
index a980f76e0..a115c0f12 100644
--- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
index 4e4169e9d..7f0a8e747 100644
--- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
index e5ee9fa70..9e0be0d2b 100644
--- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
index 17361570c..0a6acb2f8 100644
--- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
index 27d4c653c..204ffb23a 100644
--- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp
+++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp
index f715af0d4..5b22d43ba 100644
--- a/src/imports/audioengine/qdeclarative_sound_p.cpp
+++ b/src/imports/audioengine/qdeclarative_sound_p.cpp
@@ -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
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index b1c5f3cca..f2576a7fa 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -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