Commit f51ca0b9 authored by Venu's avatar Venu Committed by Venugopal Shivashankar
Browse files

Doc: Updated the \brief statements


Most of them were unnecessarily long.

Change-Id: I8942254c2211adb268e399056435e6acc940616f
Reviewed-by: default avatarLeena Miettinen <riitta-leena.miettinen@digia.com>
Showing with 38 additions and 44 deletions
...@@ -29,12 +29,11 @@ ...@@ -29,12 +29,11 @@
\example audiodevices \example audiodevices
\title Audio Devices Example \title Audio Devices Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The Audio Devices example shows the application of the audio devices \brief Testing the available audio devices and their configuration.
APIs.
This example shows how to create a simple application to list and test \e{Audio Devices} demonstrates how to create a simple application to list
the configuration for the various audio devices available on the device and test the configuration for the various audio devices available on the
or machine. This is done using the QtMobility Multimedia API. target device or desktop PC.
\image audiodevices.png \image audiodevices.png
......
...@@ -29,10 +29,9 @@ ...@@ -29,10 +29,9 @@
\example audioengine \example audioengine
\title AudioEngine Example \title AudioEngine Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The Audio Engine example demonstrates 3D sound control using \brief Enabling 3D sound control using the Qt Audio Engine API.
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. \l{Qt Audio Engine QML Types}{Qt Audio Engine} API.
\include examples-run.qdocinc \include examples-run.qdocinc
......
...@@ -29,8 +29,9 @@ ...@@ -29,8 +29,9 @@
\example audioinput \example audioinput
\title Audio Input Example \title Audio Input Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The Audio Input Example shows the use of the QAudioInput class. \brief Recording audio using the QAudioInput class
The example demonstrates the basic use cases of the QAudioInput class.
\e{Audio Input} demonstrates the basic use cases of QAudioInput.
\image audioinput-example.png \image audioinput-example.png
......
...@@ -29,10 +29,9 @@ ...@@ -29,10 +29,9 @@
\example audiooutput \example audiooutput
\title Audio Output Example \title Audio Output Example
\ingroup multimedia_examples \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 \e{Audio Output} demonstrates the basic use cases of QAudioOutput.
\l{Qt Multimedia}.
\image audiooutput-example.png \image audiooutput-example.png
......
...@@ -29,10 +29,10 @@ ...@@ -29,10 +29,10 @@
\example audiorecorder \example audiorecorder
\title Audio Recorder Example \title Audio Recorder Example
\ingroup multimedia_examples \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 \e{Audio Recorder} demonstrates how to identify the available devices and
of recording functions in the QAudioRecorder class. supported codecs, and the use of QAudioRecorder class.
\image audiorecorder.png \image audiorecorder.png
......
...@@ -29,10 +29,11 @@ ...@@ -29,10 +29,11 @@
\example spectrum \example spectrum
\title Spectrum Example \title Spectrum Example
\ingroup multimedia_examples \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 \e Spectrum demonstrates how the \l{Qt Multimedia} module can be used to
used to record and then play back an audio stream. analyze an audio stream while recording it, and also play the recorded
stream.
\image spectrum-demo.png \image spectrum-demo.png
......
...@@ -29,13 +29,11 @@ ...@@ -29,13 +29,11 @@
\example video/qmlvideo \example video/qmlvideo
\title QML Video Example \title QML Video Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Transforming video and camera viewfinder content.
\brief The QML Video Example demonstrates the various manipulations (move; \e{QML Video} demonstrates the various transformations (move; resize; rotate;
resize; rotate; change aspect ratio) which can be applied to QML \l{VideoOutput} change aspect ratio) that can be applied to QML \l VideoOutput and \l Camera
items. types.
This example demonstrates the various manipulations (move; resize; rotate;
change aspect ratio) which can be applied to QML \l{VideoOutput} items.
It also shows how native code can be combined with QML to implement more 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 advanced functionality - in this case, C++ code is used to calculate the QML
......
...@@ -30,23 +30,21 @@ ...@@ -30,23 +30,21 @@
\title QML Video Shader Effects Example \title QML Video Shader Effects Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The QML Video Shader Effects Example shows how \l {ShaderEffect} \brief Applying shader effects on video and camera viewfinder content.
can be used to apply postprocessing effects, expressed in \c GLSL, to video
and camera viewfinder content.
\include examples-run.qdocinc \include examples-run.qdocinc
\section1 Overview \section1 Overview
This example shows how a \l {ShaderEffect} can be used to apply \e{QML Video Shader Effects} demonstrates how a \l ShaderEffect can be used to
postprocessing effects, expressed in GLSL, to QML \l {VideoOutput} items. 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 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 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 frame rate. This value is rendered in QML in a semi-transparent item
overlaid on the video content. 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. the effect is implemented using a fragment shader.
Here we see an edge detection algorithm being applied to a video clip Here we see an edge detection algorithm being applied to a video clip
......
...@@ -29,10 +29,10 @@ ...@@ -29,10 +29,10 @@
\example player \example player
\title Media Player Example \title Media Player Example
\ingroup multimedia_examples \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 \e{Media Player} demonstrates a simple multimedia player that can play
or video files using various codecs. audio and or video files using various codecs.
\include examples-run.qdocinc \include examples-run.qdocinc
...@@ -40,10 +40,9 @@ ...@@ -40,10 +40,9 @@
control the video output. To give the application playlist capability control the video output. To give the application playlist capability
we also use a QPlayList object. we also use a QPlayList object.
To activate the various functions such as play and stop on the dialog 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() the button clicked events emit the play() and stop() signals, which
signals and in turn which we connect to the play() and stop() slots in are connected to the play() and stop() slots of QMediaPlayer.
QMediaPlayer.
\code \code
connect(controls, SIGNAL(play()), player, SLOT(play())); connect(controls, SIGNAL(play()), player, SLOT(play()));
......
...@@ -29,10 +29,10 @@ ...@@ -29,10 +29,10 @@
\example videographicsitem \example videographicsitem
\title Video Graphics Item Example \title Video Graphics Item Example
\ingroup multimedia_examples \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 \e{Video Graphics Item} demonstrates how to implement a QGraphicsItem that
graphics scene using \l{Qt Multimedia}'s QAbstractVideoSurface. displays video on a graphics scene using QAbstractVideoSurface.
\image video-videographicsitem.png \image video-videographicsitem.png
......
...@@ -29,10 +29,10 @@ ...@@ -29,10 +29,10 @@
\example videowidget \example videowidget
\title Video Widget Example \title Video Widget Example
\ingroup multimedia_examples \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 \e{Video Widget} demonstrates how to implement a video widget using
\l{Qt Multimedia}'s QAbstractVideoSurface. QAbstractVideoSurface.
\image video-videowidget.png \image video-videowidget.png
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment