summaryrefslogtreecommitdiffstats
path: root/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
diff options
context:
space:
mode:
authorAngus Cummings <angus.cummings@nokia.com>2012-04-30 16:49:23 +1000
committerQt by Nokia <qt-info@nokia.com>2012-05-16 05:21:25 +0200
commit9e6d03584a097964e5f08c46cd02338b0b043080 (patch)
treed00b2c09412236e387337890bb2260dc2d3741d6 /src/imports/audioengine/qdeclarative_soundinstance_p.cpp
parentfdb5c419c4fb7b1ae0268e496ccdd0ffa03b74ce (diff)
Minor doc fixes for QML
renaming QML element to QML type removing some \fn tags that were making the docs not build some rewording some new signal docs Change-Id: I9b350dad1780276959aef4105e53b91082a6083e Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'src/imports/audioengine/qdeclarative_soundinstance_p.cpp')
-rw-r--r--src/imports/audioengine/qdeclarative_soundinstance_p.cpp28
1 files changed, 17 insertions, 11 deletions
diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
index 7b852d95d..b5763df14 100644
--- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
+++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp
@@ -53,16 +53,16 @@ QT_USE_NAMESPACE
/*!
\qmlclass SoundInstance QDeclarativeSoundInstance
\since 5.0
- \brief The SoundInstance element allows you to play 3d audio content.
+ \brief The SoundInstance type allows you to play 3d audio content.
\inqmlmodule QtAudioEngine 1
\ingroup multimedia_audioengine
\inherits Item
\preliminary
- This element is part of the \b{QtAudioEngine 1.0} module.
+ This type is part of the \b{QtAudioEngine 1.0} module.
There are two ways to create SoundInstance objects. You can obtain it by calling newInstance
- method of Sound element:
+ method of a \l Sound:
\qml
import QtQuick 2.0
@@ -101,7 +101,7 @@ QT_USE_NAMESPACE
}
\endqml
- Or alternatively, you can explicitly define SoundInstance element outside of AudioEngine for
+ Or alternatively, you can explicitly define SoundInstance outside of AudioEngine for
easier qml bindings:
\qml
@@ -236,7 +236,7 @@ QDeclarativeSoundInstance::~QDeclarativeSoundInstance()
\qmlproperty string QtAudioEngine1::SoundInstance::sound
This property specifies which Sound this SoundInstance will use. Unlike some properties in
- other elements, this property can be changed dynamically.
+ other types, this property can be changed dynamically.
*/
QString QDeclarativeSoundInstance::sound() const
{
@@ -258,7 +258,7 @@ void QDeclarativeSoundInstance::setSound(const QString& sound)
}
#ifdef DEBUG_AUDIOENGINE
- qDebug() << "SoundInstance Element switch sound from [" << m_sound << "] to [" << sound << "]";
+ qDebug() << "SoundInstance switch sound from [" << m_sound << "] to [" << sound << "]";
#endif
stop();
@@ -297,11 +297,17 @@ void QDeclarativeSoundInstance::dropInstance()
This property holds the current playback state. It can be one of:
- \list
- \li StopppedState
- \li PlayingState
- \li PausedState
- \endlist
+ \table
+ \header \li Value \li Description
+ \row \li StopppedState
+ \li The SoundInstance is not playing, and when playback begins next it
+ will play from position zero.
+ \row \li PlayingState
+ \li The SoundInstance is playing the media.
+ \row \li PausedState
+ \li The SoundInstance is not playing, and when playback begins next it
+ will play from the position that it was paused at.
+ \endtable
*/
QDeclarativeSoundInstance::State QDeclarativeSoundInstance::state() const
{