Tidy up Audio documentation.

Change-Id: I864ba13375d7b8b035686c11687e76fbf672c431
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>

diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
index c148111..7795ce8 100644 (file)
--- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp
@@ -88,11 +88,10 @@ QT_USE_NAMESPACE
                 loops: Animation.Infinite
                 running: true
                 NumberAnimation {
-                duration: 8000
-                from: 0
-                to: 1
+                    duration: 8000
+                    from: 0
+                    to: 1
                 }
-
             }
         }
     }
@@ -130,17 +129,16 @@ QT_USE_NAMESPACE
                 loops: Animation.Infinite
                 running: true
                 NumberAnimation {
-                duration: 8000
-                from: 0
-                to: 1
+                    duration: 8000
+                    from: 0
+                    to: 1
                 }
-
             }
         }
     }
     \endqml
 
-    This separate AudioListener definition is allowed to make qml bindings easier in some case.
+    This separate AudioListener definition is allowed to make QML bindings easier in some cases.
 */
 
 QDeclarativeAudioListener::QDeclarativeAudioListener(QObject *parent)
@@ -157,7 +155,7 @@ QDeclarativeAudioListener::~QDeclarativeAudioListener()
 /*!
     \qmlproperty QtAudioEngine::AudioEngine QtAudioEngine::AudioListener::engine
 
-    This property holds the reference to AudioEngine, must be set only once.
+    This property holds the reference to AudioEngine, and must only be set once.
 */
 QDeclarativeAudioEngine* QDeclarativeAudioListener::engine() const
 {
@@ -173,7 +171,7 @@ void QDeclarativeAudioListener::setEngine(QDeclarativeAudioEngine *engine)
 /*!
     \qmlproperty vector3d QtAudioEngine::AudioListener::position
 
-    This property holds the 3d position of the listener.
+    This property holds the 3D position of the listener.
 */
 QVector3D QDeclarativeAudioListener::position() const
 {
@@ -192,7 +190,7 @@ void QDeclarativeAudioListener::setPosition(const QVector3D &position)
 /*!
     \qmlproperty vector3d QtAudioEngine::AudioListener::direction
 
-    This property holds the normalized 3d direction vector of the listener.
+    This property holds the normalized 3D direction vector of the listener.
 */
 QVector3D QDeclarativeAudioListener::direction() const
 {
@@ -211,7 +209,7 @@ void QDeclarativeAudioListener::setDirection(const QVector3D &direction)
 /*!
     \qmlproperty vector3d QtAudioEngine::AudioListener::velocity
 
-    This property holds the 3d velocity vector of the listener.
+    This property holds the 3D velocity vector of the listener.
 */
 QVector3D QDeclarativeAudioListener::velocity() const
 {
@@ -230,7 +228,7 @@ void QDeclarativeAudioListener::setVelocity(const QVector3D &velocity)
 /*!
     \qmlproperty vector3d QtAudioEngine::AudioListener::up
 
-    This property holds the normalized 3d up vector of the listener.
+    This property holds the normalized 3D up vector of the listener.
 */
 QVector3D QDeclarativeAudioListener::up() const
 {

diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
index ee093e9..a29f0f4 100644 (file)
--- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp
+++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp
@@ -137,8 +137,9 @@ bool QDeclarativeAudioSample::isStreaming() const
     \qmlproperty bool QtAudioEngine::AudioSample::preloaded
 
     This property indicates whether this sample needs to be preloaded or not.
-    If true, the audio engine will start loading the sample file immediately when the app started,
-    otherwise the sample will not be loaded until explicitly requested.
+    If \c true, the audio engine will start loading the sample file immediately
+    when the application starts, otherwise the sample will not be loaded until
+    explicitly requested.
 */
 
 bool QDeclarativeAudioSample::isPreloaded() const
@@ -195,8 +196,8 @@ void QDeclarativeAudioSample::setStreaming(bool streaming)
 /*!
     \qmlproperty string QtAudioEngine::AudioSample::name
 
-    This property holds the name of AudioSample, must be unique among all samples and only
-    defined once.
+    This property holds the name of the sample, which must be unique among all
+    samples and only defined once.
 */
 QString QDeclarativeAudioSample::name() const
 {
@@ -239,7 +240,7 @@ QSoundBuffer* QDeclarativeAudioSample::soundBuffer() const
 /*!
     \qmlsignal QtAudioEngine::AudioSample::loadedChanged()
 
-    This signal is emitted when \l loaded is changed
+    This signal is emitted when \l loaded is changed.
 
     The corresponding handler is \c onLoadedChanged.
 */

diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp
index 3e1543d..589c45d 100644 (file)
--- a/src/imports/multimedia/qdeclarativeaudio.cpp
+++ b/src/imports/multimedia/qdeclarativeaudio.cpp
@@ -457,7 +457,7 @@ void QDeclarativeAudio::seek(int position)
 
     This property indicates if loading of media should begin immediately.
 
-    Defaults to true, if false media will not be loaded until playback is started.
+    Defaults to \c true. If \c false, the media will not be loaded until playback is started.
 */
 
 /*!
@@ -539,7 +539,7 @@ QDeclarativeAudio::PlaybackState QDeclarativeAudio::playbackState() const
 
     This property controls whether the media will begin to play on start up.
 
-    Defaults to false, if set true the value of autoLoad will be overwritten to true.
+    Defaults to \c false. If set to \c true, the value of autoLoad will be overwritten to \c true.
 */
 
 /*!
@@ -1342,7 +1342,7 @@ void QDeclarativeAudio::_q_statusChanged()
 
     This property controls whether the media will begin to play on start up.
 
-    Defaults to false, if set true the value of autoLoad will be overwritten to true.
+    Defaults to \c false. If set to \c true, the value of autoLoad will be overwritten to \c true.
 */
 
 /*!