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

@@ -138,7 +138,7 @@ public:
supported format that is as close as possible to the format with
nearestFormat(). For instance:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Setting audio format
\snippet multimedia-snippets/audio.cpp Setting audio format
The static
functions defaultInputDevice(), defaultOutputDevice(), and
@@ -149,7 +149,7 @@ public:
For instance:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Dumping audio formats
\snippet multimedia-snippets/audio.cpp Dumping audio formats
In this code sample, we loop through all devices that are able to output
sound, i.e., play an audio stream in a supported format. For each device we

View File

@@ -76,9 +76,9 @@ QT_BEGIN_NAMESPACE
with a QIODevice opened for writing. For instance, to record to a
file, you can:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input class members
\snippet multimedia-snippets/audio.cpp Audio input class members
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input setup
\snippet multimedia-snippets/audio.cpp Audio input setup
This will start recording if the format specified is supported by
the input device (you can check this with
@@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE
snags, use the error() function to check what went wrong. We stop
recording in the \c stopRecording() slot.
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input stop recording
\snippet multimedia-snippets/audio.cpp Audio input stop recording
At any point in time, QAudioInput will be in one of four states:
active, suspended, stopped, or idle. These states are specified by
@@ -108,7 +108,7 @@ QT_BEGIN_NAMESPACE
an error is encountered. Connect to the stateChanged() signal to
handle the error:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input state changed
\snippet multimedia-snippets/audio.cpp Audio input state changed
\sa QAudioOutput, QAudioDeviceInfo
*/

View File

@@ -72,9 +72,9 @@ QT_BEGIN_NAMESPACE
needs from the io device. So playing back an audio file is as
simple as:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio output class members
\snippet multimedia-snippets/audio.cpp Audio output class members
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio output setup
\snippet multimedia-snippets/audio.cpp Audio output setup
The file will start playing assuming that the audio system and
output device support it. If you run out of luck, check what's
@@ -82,7 +82,7 @@ QT_BEGIN_NAMESPACE
After the file has finished playing, we need to stop the device:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio output state changed
\snippet multimedia-snippets/audio.cpp Audio output state changed
At any given time, the QAudioOutput will be in one of four states:
active, suspended, stopped, or idle. These states are described
@@ -110,7 +110,7 @@ QT_BEGIN_NAMESPACE
You can check for errors by connecting to the stateChanged()
signal:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio output state changed
\snippet multimedia-snippets/audio.cpp Audio output state changed
\sa QAudioInput, QAudioDeviceInfo
*/

View File

@@ -47,7 +47,7 @@
/*!
\class QSound
\brief The QSound class provides a method to play .wav sound files.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
@@ -55,12 +55,12 @@
applications: asynchronously playing a sound file. This is most
easily accomplished using the static play() function:
\snippet doc/src/snippets/multimedia-snippets/qsound.cpp 0
\snippet multimedia-snippets/qsound.cpp 0
Alternatively, create a QSound object from the sound file first
and then call the play() slot:
\snippet doc/src/snippets/multimedia-snippets/qsound.cpp 1
\snippet multimedia-snippets/qsound.cpp 1
Once created a QSound object can be queried for its fileName() and
total number of loops() (i.e. the number of times the sound will

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()