summaryrefslogtreecommitdiff
path: root/src/multimedia/doc/src/qtmultimedia-index.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-12-01 14:13:53 +0100
committerSimon Hausmann <simon.hausmann@theqtcompany.com>2015-12-07 15:44:49 +0000
commit5916caae7a043da4c5547725cccbbeb10d18e1f5 (patch)
treed203e75f1f1bd3a2076ecffa126f2c8aeab4e27b /src/multimedia/doc/src/qtmultimedia-index.qdoc
parent2b7c617e090f495bbf62c1257c822f5849c21742 (diff)
downloadqtmultimedia-5916caae7a043da4c5547725cccbbeb10d18e1f5.tar.gz
Doc: Move all doc artifacts under one project
Although the Qt Multimedia module has two submodules, a single project is sufficient to document these submodules, avoiding unnecessary maintenance overhead. Change-Id: I8fab48241b5c9aba35890a8aaa28ce7154f78c45 Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/multimedia/doc/src/qtmultimedia-index.qdoc')
-rw-r--r--src/multimedia/doc/src/qtmultimedia-index.qdoc17
1 files changed, 13 insertions, 4 deletions
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 0e2750872..e51ec97e0 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -35,10 +35,18 @@
and C++ classes to handle multimedia content. It also provides necessary
APIs to access the camera and radio functionality. The included
\l{Qt Audio Engine QML Types}{Qt Audio Engine} provides types for
- 3D positional audio playback and management.
+ 3D positional audio playback and content management.
- The \l{Qt Multimedia Widgets} module provides widget based multimedia
- classes.
+ The functionality of this module is divided into the following submodules:
+
+ \table
+ \row
+ \li \l{QtMultimedia}{Qt Multimedia}
+ \li Provides API for multimedia-specific use cases.
+ \row
+ \li \l{QtMultimediaWidgets}{Qt Multimedia Widgets}
+ \li Provides the widget-based multimedia API.
+ \endtable
\section1 Getting Started
@@ -54,6 +62,7 @@
\code
#include <QtMultimedia>
+ #include <QtMultimediaWidgets>
\endcode
\note If you are using a few classes from this module, we recommend
@@ -63,7 +72,7 @@
\c {qmake} project file:
\code
- QT += multimedia
+ QT += multimedia multimediawidgets
\endcode
\section1 QML Types and C++ Classes