Updated a lot of minor fixes to the docs and removed warnings from qdoc
Change-Id: Ib7fd75fb93c038f9e8fa9d71b6ad01fb27b97622 Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
@@ -28,7 +28,8 @@
|
||||
/*!
|
||||
\example audiodevices
|
||||
\title Audio Devices Example
|
||||
|
||||
\ingroup audio_examples
|
||||
\brief The Audio Devices example shows the application of the audio devices APIs
|
||||
|
||||
|
||||
This example shows how to create a simple application to list and test
|
||||
|
||||
@@ -28,7 +28,8 @@
|
||||
/*!
|
||||
\example audioinput
|
||||
\title Audio Input Example
|
||||
|
||||
\ingroup audio_examples
|
||||
\brief The Audio Input Example shows the use of the QAudioInput class.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -28,7 +28,8 @@
|
||||
/*!
|
||||
\example audiooutput
|
||||
\title Audio Output Example
|
||||
|
||||
\ingroup audio_examples
|
||||
\brief The Audio Output Example show the use of the QAudioOutput API.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -28,11 +28,11 @@
|
||||
/*!
|
||||
\example audiorecorder
|
||||
\title Audio Recorder Example
|
||||
\ingroup audio_examples
|
||||
\brief The Audio Recorder Example shows how to create a simple audio recorder.
|
||||
|
||||
|
||||
|
||||
This example shows how to create a simple audio recorder using the Qt
|
||||
Multimedia API.
|
||||
It demonstrates the discovery of the supported devices and codecs and the use
|
||||
of recording functions in the QAudioRecorder class.
|
||||
|
||||
We display a window for the user to select the appropriate audio input,
|
||||
codec, container, and sample rate. Allow a setting of either quality or
|
||||
|
||||
@@ -31,6 +31,7 @@
|
||||
|
||||
\example camera
|
||||
\title Camera Example
|
||||
\ingroup camera_examples
|
||||
\brief The Camera Example shows how to use the API to capture a still image
|
||||
or video.
|
||||
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
/*!
|
||||
\example declarative-camera
|
||||
\title QML Camera Example
|
||||
\ingroup camera_examples_qml
|
||||
|
||||
\brief The Camera Example shows how to use the API to capture a still image
|
||||
or video.
|
||||
@@ -43,7 +44,7 @@ Camera elements being mostly found in \e {declarative-camera.qml} and
|
||||
\e {CaptureControls.qml}.
|
||||
|
||||
In \e {declarative-camera.qml} the Camera element is initialized with an id
|
||||
of \e {camera }, a photo preview is setup, states are implemented for image
|
||||
of \e {camera}, a photo preview is setup, states are implemented for image
|
||||
preview or capture and a CaptureControls element is initialized. The initial
|
||||
\e state is \e PhotoCapture. The camera element includes a handler, \e onImageCaptured,
|
||||
for the \l {imageCaptured} signal. The handler sets up the application to process
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
/*!
|
||||
\example player
|
||||
\title Media Player Example
|
||||
\ingroup video_examples
|
||||
|
||||
|
||||
This example creates a simple multimedia player. We can play audio and
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
/*!
|
||||
\example video/qmlvideo
|
||||
\title QML Video Example
|
||||
\ingroup video_examples_qml
|
||||
|
||||
\brief The QML Video Example demonstrates the various manipulations (move;
|
||||
resize; rotate; change aspect ratio) which can be applied to QML \l{VideoOutput}
|
||||
|
||||
@@ -28,10 +28,12 @@
|
||||
/*!
|
||||
\example video/qmlvideofx
|
||||
\title QML Video Shader Effects Example
|
||||
\ingroup video_examples_qml
|
||||
\ingroup camera_examples_qml
|
||||
|
||||
\brief The QML Video Shader Effects Example shows how the \l {ShaderEffect}
|
||||
element can be used to apply postprocessing effects, expressed in GLSL, to QML
|
||||
\l {VideoOutput} items.
|
||||
element can be used to apply postprocessing effects, expressed in \c GLSL, to video
|
||||
and camera viewfinder content.
|
||||
|
||||
\section1 Overview
|
||||
|
||||
|
||||
@@ -28,7 +28,8 @@
|
||||
/*!
|
||||
\example spectrum
|
||||
\title Spectrum Example
|
||||
|
||||
\ingroup audio_examples
|
||||
\brief The Spectrum Example uses a combination multimedia APIs to process microphone input.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
36
doc/src/examples/videographicsitem.qdoc
Normal file
36
doc/src/examples/videographicsitem.qdoc
Normal file
@@ -0,0 +1,36 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/
|
||||
**
|
||||
** This file is part of the documentation of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:FDL$
|
||||
** GNU Free Documentation License
|
||||
** Alternatively, this file may be used under the terms of the GNU Free
|
||||
** Documentation License version 1.3 as published by the Free Software
|
||||
** Foundation and appearing in the file included in the packaging of
|
||||
** this file.
|
||||
**
|
||||
** Other Usage
|
||||
** Alternatively, this file may be used in accordance with the terms
|
||||
** and conditions contained in a signed written agreement between you
|
||||
** and Nokia.
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\example videographicsitem
|
||||
\title Video Graphics Item Example
|
||||
\ingroup video_examples
|
||||
|
||||
\brief This example demonstrates how to make a simple video player using the QMediaPlayer
|
||||
and QVideoGraphicsItem classes in the Graphics View framework.
|
||||
|
||||
*/
|
||||
36
doc/src/examples/videowidget.qdoc
Normal file
36
doc/src/examples/videowidget.qdoc
Normal file
@@ -0,0 +1,36 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/
|
||||
**
|
||||
** This file is part of the documentation of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:FDL$
|
||||
** GNU Free Documentation License
|
||||
** Alternatively, this file may be used under the terms of the GNU Free
|
||||
** Documentation License version 1.3 as published by the Free Software
|
||||
** Foundation and appearing in the file included in the packaging of
|
||||
** this file.
|
||||
**
|
||||
** Other Usage
|
||||
** Alternatively, this file may be used in accordance with the terms
|
||||
** and conditions contained in a signed written agreement between you
|
||||
** and Nokia.
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\example videowidget
|
||||
\title Video Widget Example
|
||||
\ingroup video_examples
|
||||
|
||||
\brief This example demonstrates how to make a simple video player using the QMediaPlayer
|
||||
and QVideoWidget classes
|
||||
|
||||
*/
|
||||
Reference in New Issue
Block a user