slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc: Move all doc artifacts under one project

Browse Source 
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>
This commit is contained in:
Venugopal Shivashankar
2015-12-01 14:13:53 +01:00
committed by Simon Hausmann
parent 2b7c617e09
commit 5916caae7a
9 changed files with 44 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/multimedia/audio/qaudio.cpp
View File

@@ -49,6 +49,7 @@ Q_CONSTRUCTOR_FUNCTION(qRegisterAudioMetaTypes)
/*!
\namespace QAudio
\ingroup multimedia-namespaces
\brief The QAudio namespace contains enums used by the audio classes.
\inmodule QtMultimedia
\ingroup multimedia

32
src/multimedia/doc/qtmultimedia-dita.qdocconf
View File

@@ -1,32 +0,0 @@
# Name of the project.
project = Qt Multimedia
# Directories in which to search for files to document and images.
# By default set to the root directory of the project for sources
# and headers and qdoc will therefore generate output for each file.
# Images should be placed in <rootdir>/dic/images and examples in
# <rootdir>/examples.
# Paths are relative to the location of this file.
exampledirs += ../src/examples \
../.. \
../../examples
headerdirs += ../src \
../../src
imagedirs += ../src/images \
sourcedirs += ../src \
../../src
excludedirs +=
#Do not change the variables after this line unless you know what you are doing.
outputdir = ../ditaxml
outputformats = DITAXML
examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"

14
src/multimedia/doc/qtmultimedia.qdocconf
View File

@@ -18,17 +18,23 @@ qhp.QtMultimedia.indexTitle = Qt Multimedia
qhp.QtMultimedia.virtualFolder = qtmultimedia
# For listing child nodes in Qt Creator or Assistant.
qhp.QtMultimedia.subprojects = classes qmltypes
qhp.QtMultimedia.subprojects = classes qmltypes examples
qhp.QtMultimedia.subprojects.classes.title = C++ Classes
qhp.QtMultimedia.subprojects.classes.indexTitle = Qt Multimedia C++ Classes
qhp.QtMultimedia.subprojects.classes.selectors = class fake:headerfile
qhp.QtMultimedia.subprojects.classes.sortPages = true
qhp.QtMultimedia.subprojects.qmltypes.title = QML Types
qhp.QtMultimedia.subprojects.qmltypes.indexTitle = Qt Multimedia QML Types
qhp.QtMultimedia.subprojects.qmltypes.selectors = qmlclass
qhp.QtMultimedia.subprojects.qmltypes.sortPages = true
exampledirs += ../../../examples/multimedia \
qhp.QtMultimedia.subprojects.examples.title = Examples
qhp.QtMultimedia.subprojects.examples.indexTitle = Qt Multimedia Examples
qhp.QtMultimedia.subprojects.examples.selectors = doc:example
qhp.QtMultimedia.subprojects.examples.sortPages = true
exampledirs += ../../../examples \
snippets
# Specify example install dir under QT_INSTALL_EXAMPLES
@@ -40,9 +46,9 @@ imagedirs += src/images \
sourcedirs += ../..
excludedirs += ../../multimediawidgets
#excludedirs += ../../multimediawidgets
depends += qtcore qtdoc qtgui qtquick qtqml qtmultimediawidgets qtwidgets
depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets
navigation.landingpage = "Qt Multimedia"
navigation.cppclassespage = "Qt Multimedia C++ Classes"

19
src/multimedia/doc/src/qtmultimedia-cpp.qdoc
View File

@@ -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}
*/

17
src/multimedia/doc/src/qtmultimedia-index.qdoc
View File

@@ -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

1
src/multimedia/qmediametadata.cpp
View File

@@ -160,6 +160,7 @@ Q_DEFINE_METADATA(ThumbnailImage);
/*!
\namespace QMediaMetaData
\ingroup multimedia-namespaces
\ingroup multimedia
\inmodule QtMultimedia

1
src/multimedia/qmultimedia.cpp
View File

@@ -31,6 +31,7 @@ QT_BEGIN_NAMESPACE
/*!
\namespace QMultimedia
\ingroup multimedia-namespaces
\ingroup multimedia
\inmodule QtMultimedia

44
src/multimediawidgets/doc/qtmultimediawidgets.qdocconf
View File

@@ -1,44 +0,0 @@
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtMultimediaWidgets
description = Qt Multimedia Widgets Documentation
version = $QT_VERSION
# The following parameters are for creating a qhp file, the qhelpgenerator
# program can convert the qhp file into a qch file which can be opened in
# Qt Assistant and/or Qt Creator.
# Defines the name of the project. You cannot use operators (+, =, -) in
# the name. Properties for this project are set using a qhp.<projectname>.property
# format.
qhp.projects = QtMultimediaWidgets
qhp.QtMultimediaWidgets.file = qtmultimediawidgets.qhp
qhp.QtMultimediaWidgets.namespace = org.qt-project.qtmultimediawidgets.$QT_VERSION_TAG
qhp.QtMultimediaWidgets.indexTitle = Qt Multimedia Widgets
qhp.QtMultimediaWidgets.virtualFolder = qtmultimediawidgets
# For listing child nodes in Qt Creator or Assistant.
qhp.QtMultimediaWidgets.subprojects = classes
qhp.QtMultimediaWidgets.subprojects.classes.title = C++ Classes
qhp.QtMultimediaWidgets.subprojects.classes.indexTitle = Qt Multimedia Widgets C++ Classes
qhp.QtMultimediaWidgets.subprojects.classes.selectors = class fake:headerfile
qhp.QtMultimediaWidgets.subprojects.classes.sortPages = true
exampledirs += ../../../examples/multimediawidgets \
snippets
# Specify example install dir under QT_INSTALL_EXAMPLES
examplesinstallpath = qtmultimedia/multimediawidgets
headerdirs += ../
imagedirs += \
sourcedirs += ../
excludedirs +=
depends += qtcore qtdoc qtquick qtqml qtmultimedia qtwidgets qtgui
navigation.landingpage = "Qt Multimedia Widgets"
navigation.cppclassespage = "Qt Multimedia Widgets C++ Classes"

2
src/multimediawidgets/multimediawidgets.pro
View File

@@ -7,8 +7,6 @@ qtHaveModule(opengl):!contains(QT_CONFIG, opengles1) {
DEFINES += QT_NO_OPENGL
}
QMAKE_DOCS = $$PWD/doc/qtmultimediawidgets.qdocconf
load(qt_module)
PRIVATE_HEADERS += \