summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc/src/qtmultimedia-cpp.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-cpp.qdoc
parent2b7c617e090f495bbf62c1257c822f5849c21742 (diff)
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-cpp.qdoc')
-rw-r--r--src/multimedia/doc/src/qtmultimedia-cpp.qdoc19
1 files changed, 18 insertions, 1 deletions
diff --git a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
index 8460238e7..44623beca 100644
--- a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
@@ -27,16 +27,33 @@
/*!
\module QtMultimedia
- \title Qt Multimedia C++ Classes
+ \title Qt Multimedia Module C++ Classes
\ingroup modules
\qtvariable multimedia
\brief The \l {Qt Multimedia} module provides audio, video, radio and camera
functionality.
+*/
+
+/*!
+ \page qtmultimedia-modules.html
+ \title Qt Multimedia C++ Classes
+ \brief Provides C++ class for multimedia use cases.
The C++ classes provide more control over the multimedia content than the
QML alternatives. If your application is serving complex use cases such as
decoding media files, accessing video or audio buffers, use the C++
alternative. For more details about the complex audio, video, and camera use
cases supported by the C++ classes, refer to \l {Multimedia}{Multimedia Overview}.
+
+ \section1 Namespaces
+ \annotatedlist multimedia-namespaces
+
+ \section1 Classes
+
+ \section2 Qt Multimedia Module
+ \generatelist {classesbymodule QtMultimedia}
+
+ \section2 Qt Multimedia Widgets Module
+ \generatelist {classesbymodule QtMultimediaWidgets}
*/