summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-01-16 16:27:32 +1000
committerQt by Nokia <qt-info@nokia.com>2012-01-17 01:57:58 +0100
commit508ca281961a9dd59f21218adfa2305b6a4c8ac1 (patch)
tree0405a1f39ed151d722a3f19ce5a461238f8512b2 /doc/src
parent53d71baed324d43bf5bac1fd50fc2eb4764b3857 (diff)
Fix up a few doc issues
* lingering references to Mobility * missing group tags on some classes meant they went missing * put classes into functional groups as well (e.g. audio, camera) * added some of the qdoc files to OTHER_FILES so they show up in Creator There are still a lot of warnings since it seems like qdoc is not processing the controls directory. Change-Id: I036f8826ae63f8273b3e649cb32c091d964ce830 Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/camera.qdoc13
-rw-r--r--doc/src/examples/hapticsplayer.qdoc73
-rw-r--r--doc/src/multimedia.qdoc40
-rw-r--r--doc/src/multimediabackend.qdoc2
-rw-r--r--doc/src/plugins/qml-multimedia.qdoc10
5 files changed, 37 insertions, 101 deletions
diff --git a/doc/src/camera.qdoc b/doc/src/camera.qdoc
index ebbe06151..1fc5d1eca 100644
--- a/doc/src/camera.qdoc
+++ b/doc/src/camera.qdoc
@@ -37,15 +37,6 @@ for still or video image capture with sound support.
\tableofcontents
-
-\section1 Namespace
-
-The QtMobility APIs are placed into the \i{QtMobility} namespace. This is done
-to facilitate the future migration of QtMobility APIs into Qt. See the
-\l {Quickstart guide} for an example on how the
-namespace impacts on application development.
-
-
\section1 Overview
The Camera API allows high level control of various aspects of still images
@@ -53,8 +44,6 @@ and video. Camera is a part of the Multimedia API and this relationship is
apparent when you notice that certain core classes are subclassed from some
Multimedia base classes including \l QMediaObject and \l QMediaControl.
-
-
\section1 Still Images
In order to capture an image we need to create a \l QCamera object and use
@@ -173,7 +162,7 @@ autoexposure or white balance cancellation can be done by calling
\section1 Classes
-\annotatedlist camera
+\annotatedlist multimedia_camera
*/
diff --git a/doc/src/examples/hapticsplayer.qdoc b/doc/src/examples/hapticsplayer.qdoc
deleted file mode 100644
index 5749d2be0..000000000
--- a/doc/src/examples/hapticsplayer.qdoc
+++ /dev/null
@@ -1,73 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
-**
-** 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 hapticsplayer
- \title Haptics Player
-
- \tableofcontents
-
- \section1 Overview
-
- This example shows how to use various haptic effects in an application via
- the \l{Feedback}{QtMobility Feedback API}.
-
- It provides an example of how to use the QtMobility libraries to:
- \list
- \o play "system theme" haptic effects corresponding to certain predefined events
- \o play a dynamic custom effect, single or repeating
- \o play a custom effect which is stored in a file
- \endlist
-
- \section2 Use Case
-
- This example is more feature complete than the \l{hapticsquare}{Haptic Square} example,
- but is intended more as a way to test the haptics provider plugins which
- are available on a system, than as an example for application developers.
-
- It is useful for people who wish to learn how to use the API to create and
- play custom effects dynamically, or to allow users of an application to
- select which haptic effect to play when a particular event occurs. It is also useful
- to test how effects are implemented on specific devices.
-
- It is a more complex example than the \l{hapticsquare}{Haptic Square} example, so it is
- suggested that developers look at that example first.
-
- \section2 Interface
- The application is designed to work on desktop and mobile platforms with
- minimal differences in code between the platforms. The interface consists
- of three tabs which allow the user to select and play different custom,
- system theme, and file effects, respectively. The custom effect tab also
- allows the user to modify the custom effect dynamically, and see the effect
- of attack and fade, intensity and duration, and periodicity, on the user
- experience.
-
- \section2 Known Issues
- The example will not work correctly on platforms which do not have a
- QFeedbackHapticInterface (haptic effect provider) plugin loaded. On such
- platforms, the example will do nothing.
-*/
diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc
index 6d7a7f00a..3abafe0c6 100644
--- a/doc/src/multimedia.qdoc
+++ b/doc/src/multimedia.qdoc
@@ -344,26 +344,46 @@ displayed around the video content pane.
\section1 Reference documentation
-\section2 Main audio and video classes
+\section2 Core classes
-\annotatedlist multimedia
+\annotatedlist multimedia_core
+
+\section2 Media playback classes
+
+\annotatedlist multimedia_playback
\section2 Camera classes
-\annotatedlist camera
+\annotatedlist multimedia_camera
+
+\section2 Radio classes
+
+\annotatedlist multimedia_radio
+
+\section2 Media recording classes
+
+\annotatedlist multimedia_recording
+
+\section2 Low level Audio related classes
+
+\annotatedlist multimedia_audio
+
+\section2 Low level Video related classes
+
+\annotatedlist multimedia_video
+
+\section2 QML Elements
+\annotatedlist multimedia_qml
+
+See also \l{Multimedia QML Plugin}
\section2 Advanced usage.
For developers wishing to access some platform specific settings, or to
port the Qt Multimedia APIs to a new platform or technology, see \l{Multimedia Backend Development}.
-\section2 QML Elements
-\list
-\o \l {SoundEffect}{SoundEffect: Low Latency Sound Effects}
-\o \l {Audio}{Audio: Music playback}
-\o \l {Video}{Video: Video playback}
-\endlist
-*/
+*
+***/
diff --git a/doc/src/multimediabackend.qdoc b/doc/src/multimediabackend.qdoc
index 968ca7d16..7d1c3459c 100644
--- a/doc/src/multimediabackend.qdoc
+++ b/doc/src/multimediabackend.qdoc
@@ -119,7 +119,7 @@ The choice of what needs to be done depends on what the developer wishes to do w
\section2 Classes for service implementers.
-\annotatedlist multimedia-serv
+\annotatedlist multimedia_control
*/
diff --git a/doc/src/plugins/qml-multimedia.qdoc b/doc/src/plugins/qml-multimedia.qdoc
index e2feae500..112db9e22 100644
--- a/doc/src/plugins/qml-multimedia.qdoc
+++ b/doc/src/plugins/qml-multimedia.qdoc
@@ -28,7 +28,7 @@
/*!
\group qml-multimedia
\title QML Multimedia Plugin
- QML Support for the QtMobility Project Multimedia API.
+ QML Support for the Qt Multimedia API.
*/
/*!
@@ -36,19 +36,19 @@
\title Multimedia QML Plugin
- \brief A QML plugin for the QtMobility Project Multimedia API.
+ \brief A QML plugin for the Qt Multimedia API.
\section1 Overview
- The Multimedia API in the QtMobility Project gives developers a simplified way to use audio and video playback, and access camera functionality. The Multimedia QML Plugin provides a QML friendly interface to these features.
+ The Qt Multimedia API gives developers a simplified way to use audio and video playback, and access camera functionality. The Multimedia QML Plugin provides a QML friendly interface to these features.
\section1 Elements
\section2 Audio
The \l Audio element is an easy way to add audio playback to a Qt Quick
- scene. QtMobility provides properties for control, methods (functions) and signals.
+ scene. QtMultimedia provides properties for control, methods (functions) and signals.
The code extract below shows the creation and use of an audio element.
@@ -285,7 +285,7 @@
\section1 Multimedia QML Elements
- \annotatedlist qml-multimedia
+ \annotatedlist multimedia_qml
*/