From f51ca0b97c90d479bac16bc549e8555bbbf5bb73 Mon Sep 17 00:00:00 2001
From: Venu <venugopal.shivashankar@digia.com>
Date: Fri, 17 Oct 2014 16:25:41 +0200
Subject: [PATCH] Doc: Updated the \brief statements
Most of them were unnecessarily long.
Change-Id: I8942254c2211adb268e399056435e6acc940616f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
---
.../audiodevices/doc/src/audiodevices.qdoc | 9 ++++-----
.../multimedia/audioengine/doc/src/audioengine.qdoc | 5 ++---
.../multimedia/audioinput/doc/src/audioinput.qdoc | 5 +++--
.../multimedia/audiooutput/doc/src/audiooutput.qdoc | 5 ++---
.../audiorecorder/doc/src/audiorecorder.qdoc | 6 +++---
examples/multimedia/spectrum/doc/src/spectrum.qdoc | 7 ++++---
examples/multimedia/video/doc/src/qmlvideo.qdoc | 10 ++++------
examples/multimedia/video/doc/src/qmlvideofx.qdoc | 10 ++++------
.../multimediawidgets/player/doc/src/player.qdoc | 13 ++++++-------
.../doc/src/videographicsitem.qdoc | 6 +++---
.../videowidget/doc/src/videowidget.qdoc | 6 +++---
11 files changed, 38 insertions(+), 44 deletions(-)
diff --git a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
index bdf1590fe..3c6a4e4d6 100644
--- a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
+++ b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
@@ -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
diff --git a/examples/multimedia/audioengine/doc/src/audioengine.qdoc b/examples/multimedia/audioengine/doc/src/audioengine.qdoc
index 52a377130..19e903b2b 100644
--- a/examples/multimedia/audioengine/doc/src/audioengine.qdoc
+++ b/examples/multimedia/audioengine/doc/src/audioengine.qdoc
@@ -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
diff --git a/examples/multimedia/audioinput/doc/src/audioinput.qdoc b/examples/multimedia/audioinput/doc/src/audioinput.qdoc
index 11a513a99..fad40aa6e 100644
--- a/examples/multimedia/audioinput/doc/src/audioinput.qdoc
+++ b/examples/multimedia/audioinput/doc/src/audioinput.qdoc
@@ -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
diff --git a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
index 60c9d00d4..c9c69ed99 100644
--- a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
+++ b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
@@ -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
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
index 35f6c0511..317bd5835 100644
--- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
+++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
@@ -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
diff --git a/examples/multimedia/spectrum/doc/src/spectrum.qdoc b/examples/multimedia/spectrum/doc/src/spectrum.qdoc
index 3c846afdc..b0adfac6b 100644
--- a/examples/multimedia/spectrum/doc/src/spectrum.qdoc
+++ b/examples/multimedia/spectrum/doc/src/spectrum.qdoc
@@ -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
diff --git a/examples/multimedia/video/doc/src/qmlvideo.qdoc b/examples/multimedia/video/doc/src/qmlvideo.qdoc
index 5ffb542fd..e50e5775a 100644
--- a/examples/multimedia/video/doc/src/qmlvideo.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideo.qdoc
@@ -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
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
index b24114084..52b5d7843 100644
--- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
@@ -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
diff --git a/examples/multimediawidgets/player/doc/src/player.qdoc b/examples/multimediawidgets/player/doc/src/player.qdoc
index 29121dce4..ac5d700da 100644
--- a/examples/multimediawidgets/player/doc/src/player.qdoc
+++ b/examples/multimediawidgets/player/doc/src/player.qdoc
@@ -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()));
diff --git a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
index 1e392ce8c..7cc2cdc87 100644
--- a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
+++ b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
@@ -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
diff --git a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
index 6b93a3c19..2a991d0fa 100644
--- a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
+++ b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
@@ -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
--
GitLab