summaryrefslogtreecommitdiffstats
path: root/doc
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
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')
-rw-r--r--doc/config/qtmobility-cpp-ignore.qdocconf18
-rw-r--r--doc/config/qtmobility-ditaxml.qdocconf13
-rw-r--r--doc/config/qtmobility-online.qdocconf2
-rw-r--r--doc/config/qtmobility-project.qdocconf142
-rw-r--r--doc/config/qtmobility.qdocconf2
-rw-r--r--doc/config/qtmultimedia_doc.pri8
-rw-r--r--doc/doc.pri31
-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
12 files changed, 45 insertions, 309 deletions
diff --git a/doc/config/qtmobility-cpp-ignore.qdocconf b/doc/config/qtmobility-cpp-ignore.qdocconf
deleted file mode 100644
index faa9fe135..000000000
--- a/doc/config/qtmobility-cpp-ignore.qdocconf
+++ /dev/null
@@ -1,18 +0,0 @@
-Cpp.ignoretokens += \
- QTM_BEGIN_NAMESPACE \
- QTM_END_NAMESPACE \
- Q_BEARER_EXPORT \
- Q_PUBLISHSUBSCRIBE_EXPORT \
- Q_CONTACTS_EXPORT \
- Q_VERSIT_EXPORT \
- Q_LOCATION_EXPORT \
- Q_MULTIMEDIA_EXPORT \
- Q_MESSAGING_EXPORT \
- Q_SERVICEFW_EXPORT \
- Q_SYSINFO_EXPORT \
- Q_SENSORS_EXPORT \
- Q_FEEDBACK_EXPORT \
- Q_GALLERY_EXPORT \
- Q_ORGANIZER_EXPORT
-Cpp.ignoredirectives += \
- Q_DECLARE_NDEF_RECORD
diff --git a/doc/config/qtmobility-ditaxml.qdocconf b/doc/config/qtmobility-ditaxml.qdocconf
deleted file mode 100644
index 338e40863..000000000
--- a/doc/config/qtmobility-ditaxml.qdocconf
+++ /dev/null
@@ -1,13 +0,0 @@
-include(qtmobility-project.qdocconf)
-
-outputdir = ../ditaxml
-outputformats = DITAXML
-
-generateindex = true
-url = .
-
-macro.beginfloatleft.HTML = " "
-macro.beginfloatright.HTML = " "
-macro.endfloat.HTML = " "
-macro.clearfloat.HTML = " "
-macro.emptyspan.DITAXML = " "
diff --git a/doc/config/qtmobility-online.qdocconf b/doc/config/qtmobility-online.qdocconf
deleted file mode 100644
index 515003a34..000000000
--- a/doc/config/qtmobility-online.qdocconf
+++ /dev/null
@@ -1,2 +0,0 @@
-include(qtmobility-project.qdocconf)
-include(qt-html-templates-online.qdocconf)
diff --git a/doc/config/qtmobility-project.qdocconf b/doc/config/qtmobility-project.qdocconf
deleted file mode 100644
index 8a29b0a8f..000000000
--- a/doc/config/qtmobility-project.qdocconf
+++ /dev/null
@@ -1,142 +0,0 @@
-include(compat.qdocconf)
-include(macros.qdocconf)
-include(qt-cpp-ignore.qdocconf)
-include(qt-defines.qdocconf)
-include(qtmobility-cpp-ignore.qdocconf)
-
-indexes = ../src/qt.index
-
-language = Cpp
-
-sourceencoding = UTF-8
-outputencoding = UTF-8
-naturallanguage = en_US
-
-project = Qt Mobility
-description = Qt Mobility Project Library Reference Documentation
-versionsym =
-version = 1.2
-url = http://qt.nokia.com/doc/qtmobility-1.2
-
-sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
-headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx"
-examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
-examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
-
-headerdirs = ../../src/global \
- ../../src/bearer \
- ../../src/feedback \
- ../../src/serviceframework \
- ../../src/location \
- ../../src/publishsubscribe \
- ../../src/systeminfo \
- ../../src/contacts \
- ../../src/contacts/details \
- ../../src/multimedia \
- ../../plugins/declarative/multimedia \
- ../../plugins/declarative/location \
- ../../plugins/declarative/organizer \
- ../../plugins/declarative/connectivity \
- ../../plugins/declarative/contacts \
- ../../plugins/declarative/contacts/details \
- ../../plugins/declarative/contacts/filters \
- ../../plugins/declarative/gallery \
- ../../plugins/declarative/serviceframework \
- ../../plugins/declarative/organizer \
- ../../plugins/declarative/contacts \
- ../../plugins/declarative/feedback \
- ../../plugins/declarative/messaging \
- ../../plugins/declarative/sensors \
- ../../plugins/declarative/publishsubscribe \
- ../../plugins/declarative/systeminfo \
- ../../src/messaging \
- ../../src/versit \
- ../../src/sensors \
- ../../src/gallery \
- ../../src/camera \
- ../../src/organizer \
- ../../src/versitorganizer \
- ../../src/connectivity \
- ../src
-
-sourcedirs = ../../src/global \
- ../../src/bearer \
- ../../src/feedback \
- ../../src/serviceframework \
- ../../src/location \
- ../../src/publishsubscribe \
- ../../src/systeminfo \
- ../../src/contacts \
- ../../src/contacts/details \
- ../../src/multimedia \
- ../../plugins/declarative/multimedia \
- ../../plugins/declarative/location \
- ../../plugins/declarative/organizer \
- ../../plugins/declarative/connectivity \
- ../../plugins/declarative/contacts \
- ../../plugins/declarative/contacts/details \
- ../../plugins/declarative/contacts/filters \
- ../../plugins/declarative/messaging \
- ../../plugins/declarative/serviceframework \
- ../../plugins/declarative/organizer \
- ../../plugins/declarative/contacts \
- ../../plugins/declarative/feedback \
- ../../plugins/declarative/gallery \
- ../../plugins/declarative/sensors \
- ../../plugins/declarative/publishsubscribe \
- ../../plugins/declarative/systeminfo \
- ../../plugins/declarative/sensors \
- ../../src/messaging \
- ../../src/versit \
- ../../src/sensors \
- ../../src/gallery \
- ../../src/camera \
- ../../src/organizer \
- ../../src/connectivity \
- ../../src/versitorganizer \
- ../src
-
-excludedirs = ../../src/messaging/win32wce \
- ../../src/publishsubscribe/symbian \
- ../../src/serviceframework/ipc/metaobjectbuilder47
-
-exampledirs = ../../examples \
- ../../demos \
- ../.. \
- ../src
-
-imagedirs = images \
- ../src/images
-
-outputdir = ../html
-tagfile = ../html/qtmobility.tags
-base = file:../html
-
-qhp.projects = QtMobility
-
-qhp.QtMobility.file = qtmobility.qhp
-qhp.QtMobility.namespace = com.nokia.qtmobility.114
-qhp.QtMobility.virtualFolder = mobility
-qhp.QtMobility.indexTitle = Qt Mobility Project Reference Documentation
-qhp.QtMobility.indexRoot =
-
-qhp.QtMobility.filterAttributes = qtmobility 1.2.0
-qhp.QtMobility.customFilters.QtMobility.name = Qt Mobility 1.2.0
-qhp.QtMobility.customFilters.QtMobility.filterAttributes = qtmobility 1.2.0
-qhp.QtMobility.subprojects = classes overviews examples
-qhp.QtMobility.subprojects.classes.title = Classes
-qhp.QtMobility.subprojects.classes.indexTitle = All Qt Mobility Project Classes
-qhp.QtMobility.subprojects.classes.selectors = class
-qhp.QtMobility.subprojects.classes.sortPages = true
-qhp.QtMobility.subprojects.overviews.title = Overviews
-qhp.QtMobility.subprojects.overviews.indexTitle = Qt Mobility Project Overview
-qhp.QtMobility.subprojects.overviews.selectors = fake:page,group
-qhp.QtMobility.subprojects.overviews.sortPages = true
-qhp.QtMobility.subprojects.examples.title = Examples
-qhp.QtMobility.subprojects.examples.indexTitle = Qt Mobility Project Examples
-qhp.QtMobility.subprojects.examples.selectors = fake:example
-qhp.QtMobility.subprojects.examples.sortPages = true
-qhp.QtMobility.subprojects.tutorials.title = Tutorials
-qhp.QtMobility.subprojects.tutorials.indexTitle = Qt Mobility Project Tutorials
-qhp.QtMobility.subprojects.tutorials.selectors = fake:tutorial
-qhp.QtMobility.subprojects.tutorials.sortPages = true
diff --git a/doc/config/qtmobility.qdocconf b/doc/config/qtmobility.qdocconf
deleted file mode 100644
index 75fba31d3..000000000
--- a/doc/config/qtmobility.qdocconf
+++ /dev/null
@@ -1,2 +0,0 @@
-include(qtmobility-project.qdocconf)
-include(qt-html-templates.qdocconf)
diff --git a/doc/config/qtmultimedia_doc.pri b/doc/config/qtmultimedia_doc.pri
index 622924102..05af0678a 100644
--- a/doc/config/qtmultimedia_doc.pri
+++ b/doc/config/qtmultimedia_doc.pri
@@ -33,3 +33,11 @@ QMAKE_EXTRA_TARGETS += docs dita_docs online_docs qch_docs
QMAKE_CLEAN += \
"-r $$PWD/../html" \
"-r $$PWD/../ditaxml"
+
+
+OTHER_FILES += \
+ doc/src/multimedia.qdoc \
+ doc/src/camera.qdoc \
+ doc/src/multimediabackend.qdoc \
+ doc/src/radiooverview.qdoc \
+ doc/src/plugins/qml-multimedia.qdoc
diff --git a/doc/doc.pri b/doc/doc.pri
deleted file mode 100644
index 285a8870e..000000000
--- a/doc/doc.pri
+++ /dev/null
@@ -1,31 +0,0 @@
-
-win32:!win32-g++ {
- unixstyle = false
-} else:win32-g++:isEmpty(QMAKE_SH) {
- unixstyle = false
-} else {
- unixstyle = true
-}
-
-LINE_SEP=$$escape_expand(\\n\\t)
-GENERATOR = $$[QT_INSTALL_BINS]/qhelpgenerator
-QDOC = $$[QT_INSTALL_BINS]/qdoc3
-MOBILITY_DOCUMENTATION = $$QDOC $${QT_MOBILITY_SOURCE_TREE}/doc/config/qtmobility.qdocconf $$LINE_SEP \
- cd $${QT_MOBILITY_SOURCE_TREE} && \
- $$GENERATOR doc/html/qtmobility.qhp -o doc/qch/qtmobility.qch
-
-ONLINE_MOBILITY_DOCUMENTATION = $$QDOC $${QT_MOBILITY_SOURCE_TREE}/doc/config/qtmobility-online.qdocconf $$LINE_SEP \
- cd $${QT_MOBILITY_SOURCE_TREE} && \
- $$GENERATOR doc/html/qtmobility.qhp -o doc/qch/qtmobility.qch
-
-contains(unixstyle, false):MOBILITY_DOCUMENTATION = $$replace(MOBILITY_DOCUMENTATION, "/", "\\")
-
-# Build rules
-qch_docs.commands = $$MOBILITY_DOCUMENTATION
-qch_onlinedocs.commands = $$ONLINE_MOBILITY_DOCUMENTATION
-
-docs.depends = qch_docs
-onlinedocs.depends = qch_onlinedocs
-
-
-QMAKE_EXTRA_TARGETS += qch_docs qch_onlinedocs docs onlinedocs
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
*/