From 5916caae7a043da4c5547725cccbbeb10d18e1f5 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Tue, 1 Dec 2015 14:13:53 +0100 Subject: Doc: Move all doc artifacts under one project MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö --- src/multimedia/doc/src/qtmultimedia-cpp.qdoc | 19 ++++++++++++++++++- src/multimedia/doc/src/qtmultimedia-index.qdoc | 17 +++++++++++++---- 2 files changed, 31 insertions(+), 5 deletions(-) (limited to 'src/multimedia/doc/src') 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} */ 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 + #include \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 -- cgit v1.2.3