Fix up various doc issues.
Change-Id: I43a8b1b982c4af093bd0bb14573f2299ae28ae94 Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
35
doc/src/examples/audioinput.qdoc
Normal file
35
doc/src/examples/audioinput.qdoc
Normal file
@@ -0,0 +1,35 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** 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 audioinput
|
||||
\title Audio Input Example
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
37
doc/src/examples/audiooutput.qdoc
Normal file
37
doc/src/examples/audiooutput.qdoc
Normal file
@@ -0,0 +1,37 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** 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 audiooutput
|
||||
\title Audio Output Example
|
||||
|
||||
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -53,9 +53,9 @@ interface object.
|
||||
The Camera constructor does some basic initialization. The camera object is
|
||||
set to '0', the user interface is initialized and UI signal are connected to
|
||||
slots that react to the triggering event. However, most of the work is done when
|
||||
the \i {setCamera()} function is called, passing in a \l {QByteArray}.
|
||||
the \e {setCamera()} function is called, passing in a \l {QByteArray}.
|
||||
|
||||
\i {setCamera()} sets up various connections between the user interface and the functionality
|
||||
\e {setCamera()} sets up various connections between the user interface and the functionality
|
||||
of the Camera class using signals and slots. It also instantiates and initializes the \l {QCamera},
|
||||
\l {QCameraImageCapture} and \l {QMediaRecorder} objects mentioned above. The still
|
||||
and video recording visual tabs are enabled and finally the
|
||||
@@ -65,10 +65,10 @@ Now that the camera is ready for user commands it waits for a suitable event.
|
||||
Such an event will be the key press of either the \l {Qt::Key_CameraFocus} or
|
||||
\l {Qt::Key_Camera} buttons on the application window. Camera focus will
|
||||
simply display the viewfinder and lock the camera settings. Key_Camera will
|
||||
either call \i {takeImage()} if the \l {QCamera::captureMode()}{captureMode()}
|
||||
either call \e {takeImage()} if the \l {QCamera::captureMode()}{captureMode()}
|
||||
is QCamera::CaptureStillImage, or if the capture mode is for video then one
|
||||
of two actions will occur. If the recording state shows that we are currently
|
||||
recording then the \i {stop()} function is called resulting in a call to
|
||||
recording then the \e {stop()} function is called resulting in a call to
|
||||
\l {QCamera::stop()}, whereas if we are not recording then a video recording
|
||||
is started with a call to \l {QMediaRecorder::record()}.
|
||||
|
||||
|
||||
@@ -39,25 +39,25 @@ plugin provides access to the API functionality for camera settings and
|
||||
capturing an image.
|
||||
|
||||
Most of the QML code supports the user interface for this application with the
|
||||
Camera elements being mostly found in \i {declarative-camera.qml} and
|
||||
\i {CaptureControls.qml}.
|
||||
Camera elements being mostly found in \e {declarative-camera.qml} and
|
||||
\e {CaptureControls.qml}.
|
||||
|
||||
In \i {declarative-camera.qml} the Camera element is initialized with an id
|
||||
of \i {camera }, a photo preview is setup, states are implemented for image
|
||||
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
|
||||
preview or capture and a CaptureControls element is initialized. The initial
|
||||
\i state is \i PhotoCapture. The camera element includes a handler, \i onImageCaptured,
|
||||
\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
|
||||
the preview including a change in the user interface state. The PhotoPreview
|
||||
element now becomes visible with any key press being picked up by the handler
|
||||
in PhotoPreview and returning the state to \i PhotoCapture.
|
||||
in PhotoPreview and returning the state to \e PhotoCapture.
|
||||
|
||||
The \i CaptureControls element, which is implemented in \i {CaptureControls.qml},
|
||||
The \e CaptureControls element, which is implemented in \e {CaptureControls.qml},
|
||||
generates a column on the right hand side of the screen which includes control
|
||||
buttons for \i focus (not initially visible), \i {capture}, \i {flash modes},
|
||||
\i {white balance}, \i {exposure compensation}, and if a preview is
|
||||
available a \i {preview} button. The last button exits from the application.
|
||||
buttons for \e focus (not initially visible), \e {capture}, \e {flash modes},
|
||||
\e {white balance}, \e {exposure compensation}, and if a preview is
|
||||
available a \e {preview} button. The last button exits from the application.
|
||||
|
||||
When the Capture button is pressed the \i onClicked handler calls
|
||||
When the Capture button is pressed the \e onClicked handler calls
|
||||
\l {Camera::captureImage()}{captureImage()}
|
||||
|
||||
|
||||
|
||||
35
doc/src/examples/declarative-radio.qdoc
Normal file
35
doc/src/examples/declarative-radio.qdoc
Normal file
@@ -0,0 +1,35 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** 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 declarative-radio
|
||||
\title Declarative Radio Example
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
35
doc/src/examples/spectrum.qdoc
Normal file
35
doc/src/examples/spectrum.qdoc
Normal file
@@ -0,0 +1,35 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** 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 spectrum
|
||||
\title Spectrum Example
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user