Doc: Updated the \brief statements

Most of them were unnecessarily long.

Change-Id: I8942254c2211adb268e399056435e6acc940616f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This commit is contained in:
Venu
2014-10-17 16:25:41 +02:00
committed by Venugopal Shivashankar
parent b366a99eb1
commit f51ca0b97c
11 changed files with 38 additions and 44 deletions

View File

@@ -29,12 +29,11 @@
\example audiodevices
\title Audio Devices Example
\ingroup multimedia_examples
\brief The Audio Devices example shows the application of the audio devices
APIs.
\brief Testing the available audio devices and their configuration.
This example shows how to create a simple application to list and test
the configuration for the various audio devices available on the device
or machine. This is done using the QtMobility Multimedia API.
\e{Audio Devices} demonstrates how to create a simple application to list
and test the configuration for the various audio devices available on the
target device or desktop PC.
\image audiodevices.png

View File

@@ -29,10 +29,9 @@
\example audioengine
\title AudioEngine Example
\ingroup multimedia_examples
\brief The Audio Engine example demonstrates 3D sound control using
the Qt Audio Engine API.
\brief Enabling 3D sound control using the Qt Audio Engine API.
The Audio Engine example demonstrates 3D sound control using the
\e{Audio Engine} demonstrates 3D sound control using the
\l{Qt Audio Engine QML Types}{Qt Audio Engine} API.
\include examples-run.qdocinc

View File

@@ -29,8 +29,9 @@
\example audioinput
\title Audio Input Example
\ingroup multimedia_examples
\brief The Audio Input Example shows the use of the QAudioInput class.
The example demonstrates the basic use cases of the QAudioInput class.
\brief Recording audio using the QAudioInput class
\e{Audio Input} demonstrates the basic use cases of QAudioInput.
\image audioinput-example.png

View File

@@ -29,10 +29,9 @@
\example audiooutput
\title Audio Output Example
\ingroup multimedia_examples
\brief The Audio Output Example show the use of the QAudioOutput API.
\brief Enabling audio playback using the QAudioOutput class.
The example demonstrates the basic use cases of the QAudioOutput class from
\l{Qt Multimedia}.
\e{Audio Output} demonstrates the basic use cases of QAudioOutput.
\image audiooutput-example.png

View File

@@ -29,10 +29,10 @@
\example audiorecorder
\title Audio Recorder Example
\ingroup multimedia_examples
\brief The Audio Recorder Example shows how to create a simple audio recorder.
\brief Discovering the available devices and supported codecs.
It demonstrates the discovery of the supported devices and codecs and the use
of recording functions in the QAudioRecorder class.
\e{Audio Recorder} demonstrates how to identify the available devices and
supported codecs, and the use of QAudioRecorder class.
\image audiorecorder.png

View File

@@ -29,10 +29,11 @@
\example spectrum
\title Spectrum Example
\ingroup multimedia_examples
\brief The Spectrum Example uses a combination multimedia APIs to process microphone input.
\brief Analyzing a raw audio stream using the FFTReal library.
The Spectrum Analyzer example shows how the \l{Qt Multimedia} module can be
used to record and then play back an audio stream.
\e Spectrum demonstrates how the \l{Qt Multimedia} module can be used to
analyze an audio stream while recording it, and also play the recorded
stream.
\image spectrum-demo.png

View File

@@ -29,13 +29,11 @@
\example video/qmlvideo
\title QML Video Example
\ingroup multimedia_examples
\brief Transforming video and camera viewfinder content.
\brief The QML Video Example demonstrates the various manipulations (move;
resize; rotate; change aspect ratio) which can be applied to QML \l{VideoOutput}
items.
This example demonstrates the various manipulations (move; resize; rotate;
change aspect ratio) which can be applied to QML \l{VideoOutput} items.
\e{QML Video} demonstrates the various transformations (move; resize; rotate;
change aspect ratio) that can be applied to QML \l VideoOutput and \l Camera
types.
It also shows how native code can be combined with QML to implement more
advanced functionality - in this case, C++ code is used to calculate the QML

View File

@@ -30,23 +30,21 @@
\title QML Video Shader Effects Example
\ingroup multimedia_examples
\brief The QML Video Shader Effects Example shows how \l {ShaderEffect}
can be used to apply postprocessing effects, expressed in \c GLSL, to video
and camera viewfinder content.
\brief Applying shader effects on video and camera viewfinder content.
\include examples-run.qdocinc
\section1 Overview
This example shows how a \l {ShaderEffect} can be used to apply
postprocessing effects, expressed in GLSL, to QML \l {VideoOutput} items.
\e{QML Video Shader Effects} demonstrates how a \l ShaderEffect can be used to
apply postprocessing effects, expressed in GLSL, to QML \l VideoOutput type.
It also shows how native code can be combined with QML to implement more
advanced functionality - in this case, C++ code is used to calculate the QML
frame rate. This value is rendered in QML in a semi-transparent item
overlaid on the video content.
The following screenshots show shader effects being applied. In each case,
The following screenshots show shader effects being applied. In each case,
the effect is implemented using a fragment shader.
Here we see an edge detection algorithm being applied to a video clip

View File

@@ -29,10 +29,10 @@
\example player
\title Media Player Example
\ingroup multimedia_examples
\brief Demonstrates the audio and video playback functionality
\brief Playing audio and video.
This example creates a simple multimedia player. We can play audio and
or video files using various codecs.
\e{Media Player} demonstrates a simple multimedia player that can play
audio and or video files using various codecs.
\include examples-run.qdocinc
@@ -40,10 +40,9 @@
control the video output. To give the application playlist capability
we also use a QPlayList object.
To activate the various functions such as play and stop on the dialog
we connect clicked() signals to slots that emit the play() and stop()
signals and in turn which we connect to the play() and stop() slots in
QMediaPlayer.
To activate the various functions such as play and stop on the dialog,
the button clicked events emit the play() and stop() signals, which
are connected to the play() and stop() slots of QMediaPlayer.
\code
connect(controls, SIGNAL(play()), player, SLOT(play()));

View File

@@ -29,10 +29,10 @@
\example videographicsitem
\title Video Graphics Item Example
\ingroup multimedia_examples
\brief This example demonstrates how to stream video on a graphics scene.
\brief Streaming video on a graphics scene.
The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a
graphics scene using \l{Qt Multimedia}'s QAbstractVideoSurface.
\e{Video Graphics Item} demonstrates how to implement a QGraphicsItem that
displays video on a graphics scene using QAbstractVideoSurface.
\image video-videographicsitem.png

View File

@@ -29,10 +29,10 @@
\example videowidget
\title Video Widget Example
\ingroup multimedia_examples
\brief This example is a simple video player
\brief Implementing a video player widget.
The Video Widget example denonstrates how to implement a video widget using
\l{Qt Multimedia}'s QAbstractVideoSurface.
\e{Video Widget} demonstrates how to implement a video widget using
QAbstractVideoSurface.
\image video-videowidget.png