Doc: Fixed random QDoc warnings

- Fixed \snippet paths
- Minor language edits
- Removed unnecessary multiple page commands in a single comment
block. For example, \fn and \qmlsignal in a single comment block
is not allowed. Such instances must be documented in separate
comment blocks.

Change-Id: I65f4518499e2600c4e1807356d4116c575e48c19
Reviewed-by: Andy Nichols <andy.nichols@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Venugopal Shivashankar
2013-01-03 17:50:32 +01:00
committed by The Qt Project
parent 304fdbeeb1
commit 51334d2995
26 changed files with 58 additions and 67 deletions

View File

@@ -67,13 +67,13 @@ QT_BEGIN_NAMESPACE
This example shows how a looping, somewhat quiet sound effect
can be played:
\snippet doc/src/snippets/multimedia-snippets/qsound.cpp 2
\snippet multimedia-snippets/qsound.cpp 2
Typically the sound effect should be reused, which allows all the
parsing and preparation to be done ahead of time, and only triggered
when necessary. This assists with lower latency audio playback.
\snippet doc/src/snippets/multimedia-snippets/qsound.cpp 3
\snippet multimedia-snippets/qsound.cpp 3
Since QSoundEffect requires slightly more resources to achieve lower
latency playback, the platform may limit the number of simultaneously playing
@@ -107,7 +107,7 @@ QT_BEGIN_NAMESPACE
The following example plays a WAV file on mouse click.
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml complete snippet
\snippet multimedia-snippets/soundeffect.qml complete snippet
Since SoundEffect requires slightly more resources to achieve lower
latency playback, the platform may limit the number of simultaneously playing
@@ -340,7 +340,7 @@ bool QSoundEffect::isLoaded() const
This is the default method for SoundEffect.
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml play sound on click
\snippet multimedia-snippets/soundeffect.qml play sound on click
*/
/*!
\fn QSoundEffect::play()