Make the qtdoc repo part of the modularized build

The monolithic build is now partially removed, but there's still a lot
of cruft left that we'll remove once we know what we need or not need.

This introduces a bunch of qdoc warnings for examplee documentation that
live in the qdoc repo, but that references an example that lives in the
module. These example docs should be moved to the corresponding module.

Change-Id: I15f9f9087f1e96786ce2a49a7192f1015cb192db
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
This commit is contained in:
Tor Arne Vestbø 2012-10-15 19:47:45 +02:00
parent 690e48eb3d
commit a305423c92
27 changed files with 61 additions and 575 deletions

View File

@ -1,3 +0,0 @@
# This file is used as a placeholder for modules that are not found by the
# checks in the doc/doc.pri file. This ensures that the include directives
# for each module refer to existing files.

View File

@ -1,17 +0,0 @@
headerdirs += $QT_3D_SOURCES/..
sourcedirs += $QT_3D_SOURCES/.. \
$QT_3D_SOURCES/../../doc/src
exampledirs += $QT_3D_SOURCES/../../examples \
$QT_3D_SOURCES/../../demos \
$QT_3D_SOURCES/../../tutorials \
$QT_3D_SOURCES/../../src/plugins \
$QT_3D_SOURCES/../../doc/src/legal/snippets
imagedirs += $QT_3D_SOURCES/../../doc/src/images \
$QT_3D_SOURCES/../../examples/qt3d \
$QT_3D_SOURCES/../../examples/quick3d
excludedirs += $QT_3D_SOURCES/../../doc/src/legal/snippets

View File

@ -1,15 +0,0 @@
headerdirs += $QT_ACTIVEQT_SOURCES/.. \
$QT_ACTIVEQT_SOURCES/../tools
sourcedirs += $QT_ACTIVEQT_SOURCES/.. \
$QT_ACTIVEQT_SOURCES/../../doc/src \
$QT_ACTIVEQT_SOURCES/../../tools
exampledirs += $QT_ACTIVEQT_SOURCES/../.. \
$QT_ACTIVEQT_SOURCES/../../doc/src \
$QT_ACTIVEQT_SOURCES/../../examples
imagedirs += $QT_ACTIVEQT_SOURCES/../../doc/src/images \
$QT_ACTIVEQT_SOURCES/../../examples
excludedirs += $QT_ACTIVEQT_SOURCES/doc/src/snippets

View File

@ -1,16 +0,0 @@
# QT_BLUETOOTH_SOURCES points to qtconnectivity/src/bluetooth
headerdirs += $QT_BLUETOOTH_SOURCES \
$QT_BLUETOOTH_SOURCES/../../examples
sourcedirs += $QT_BLUETOOTH_SOURCES \
$QT_BLUETOOTH_SOURCES/../../doc/src \
$QT_BLUETOOTH_SOURCES/../../examples
exampledirs += $QT_BLUETOOTH_SOURCES/../../examples \
$QT_BLUETOOTH_SOURCES/../../doc/src
imagedirs += $QT_BLUETOOTH_SOURCES/../../doc/src/images
excludedirs += $QT_BLUETOOTH_SOURCES/../imports/bluetooth \
$QT_BLUETOOTH_SOURCES/../../doc/src/snippets

View File

@ -1,13 +0,0 @@
# Declarations for the qttools module.
headerdirs += $QT_CLUCENE_SOURCES/../../..
sourcedirs += $QT_CLUCENE_SOURCES/../../.. \
$QT_CLUCENE_SOURCES/../../../doc/src
exampledirs += $QT_CLUCENE_SOURCES/../../.. \
$QT_CLUCENE_SOURCES/../../../doc/src \
$QT_CLUCENE_SOURCES/../../../examples
imagedirs += $QT_CLUCENE_SOURCES/../../../doc/src/images \
$QT_CLUCENE_SOURCES/../../../examples

View File

@ -1,13 +0,0 @@
headerdirs += $QT_CONTACTS_SOURCES/..
sourcedirs += $QT_CONTACTS_SOURCES/.. \
$QT_CONTACTS_SOURCES/../../doc/src
exampledirs += $QT_CONTACTS_SOURCES/../.. \
$QT_CONTACTS_SOURCES/../../doc/src \
$QT_CONTACTS_SOURCES/../../examples
imagedirs += $QT_CONTACTS_SOURCES/../../doc/src/images \
$QT_CONTACTS_SOURCES/../../examples
excludedirs += $QT_CONTACTS_SOURCES/../../doc/src/snippets

View File

@ -1,89 +0,0 @@
headerdirs += $QT_CORE_SOURCES/.. \
$QT_CORE_SOURCES/../../tools
sourcedirs += $QT_CORE_SOURCES/.. \
$QT_CORE_SOURCES/../../doc/src \
$QT_CORE_SOURCES/../../tools
exampledirs += $QT_CORE_SOURCES/../.. \
$QT_CORE_SOURCES/../../doc/src \
$QT_CORE_SOURCES/../../examples/dbus \
$QT_CORE_SOURCES/../../examples/embedded \
$QT_CORE_SOURCES/../../examples/gestures \
$QT_CORE_SOURCES/../../examples/gui \
$QT_CORE_SOURCES/../../examples/ipc \
$QT_CORE_SOURCES/../../examples/linguist \
$QT_CORE_SOURCES/../../examples/network \
$QT_CORE_SOURCES/../../examples/opengl \
$QT_CORE_SOURCES/../../examples/qmake \
$QT_CORE_SOURCES/../../examples/qpa \
$QT_CORE_SOURCES/../../examples/qtconcurrent \
$QT_CORE_SOURCES/../../examples/qtestlib \
$QT_CORE_SOURCES/../../examples/sql \
$QT_CORE_SOURCES/../../examples/threads \
$QT_CORE_SOURCES/../../examples/tools \
$QT_CORE_SOURCES/../../examples/touch \
$QT_CORE_SOURCES/../../examples/tutorials \
$QT_CORE_SOURCES/../../examples/webkit \
$QT_CORE_SOURCES/../../examples/widgets \
$QT_CORE_SOURCES/../../examples/xml \
$QT_CORE_SOURCES/doc/snippets \
$QT_CORE_SOURCES/../concurrent/doc/snippets \
$QT_CORE_SOURCES/../dbus/doc/snippets \
$QT_CORE_SOURCES/../gui/doc/snippets \
$QT_CORE_SOURCES/../network/doc/snippets \
$QT_CORE_SOURCES/../opengl/doc/snippets \
$QT_CORE_SOURCES/../printsupport/doc/snippets \
$QT_CORE_SOURCES/../sql/doc/snippets \
$QT_CORE_SOURCES/../testlib/doc/snippets \
$QT_CORE_SOURCES/../widgets/doc/snippets \
$QT_CORE_SOURCES/../xml/doc/snippets
imagedirs += $QT_CORE_SOURCES/../../doc/src/images \
$QT_CORE_SOURCES/../../examples \
$QT_CORE_SOURCES/doc/images \
$QT_CORE_SOURCES/../concurrent/doc/images \
$QT_CORE_SOURCES/../gui/doc/images \
$QT_CORE_SOURCES/../printsupport/doc/images \
$QT_CORE_SOURCES/../sql/doc/images \
$QT_CORE_SOURCES/../widgets/doc/images
excludedirs += $QT_CORE_SOURCES/../tools/qdoc \
$QT_CORE_SOURCES/../doc/src/snippets \
$QT_CORE_SOURCES/../concurrent/doc/snippets \
$QT_CORE_SOURCES/../corelib/doc/snippets \
$QT_CORE_SOURCES/../dbus/doc/snippets \
$QT_CORE_SOURCES/../gui/doc/snippets \
$QT_CORE_SOURCES/../network/doc/snippets \
$QT_CORE_SOURCES/../opengl/doc/snippets \
$QT_CORE_SOURCES/../printsupport/doc/snippets \
$QT_CORE_SOURCES/../sql/doc/snippets \
$QT_CORE_SOURCES/../testlib/doc/snippets \
$QT_CORE_SOURCES/../widgets/doc/snippets \
$QT_CORE_SOURCES/../xml/doc/snippets \
$QT_CORE_SOURCES/../3rdparty/ce-compat \
$QT_CORE_SOURCES/../3rdparty/des \
$QT_CORE_SOURCES/../3rdparty/easing \
$QT_CORE_SOURCES/../3rdparty/fonts \
$QT_CORE_SOURCES/../3rdparty/freetype \
$QT_CORE_SOURCES/../3rdparty/harfbuzz \
$QT_CORE_SOURCES/../3rdparty/libjpeg \
$QT_CORE_SOURCES/../3rdparty/libmng \
$QT_CORE_SOURCES/../3rdparty/libpng \
$QT_CORE_SOURCES/../3rdparty/libtiff \
$QT_CORE_SOURCES/../3rdparty/md4 \
$QT_CORE_SOURCES/../3rdparty/md5 \
$QT_CORE_SOURCES/../3rdparty/patches \
$QT_CORE_SOURCES/../3rdparty/pcre \
$QT_CORE_SOURCES/../3rdparty/pixman \
$QT_CORE_SOURCES/../3rdparty/powervr \
$QT_CORE_SOURCES/../3rdparty/ptmalloc \
$QT_CORE_SOURCES/../3rdparty/s60 \
$QT_CORE_SOURCES/../3rdparty/sha1 \
$QT_CORE_SOURCES/../3rdparty/sqlite \
$QT_CORE_SOURCES/../3rdparty/wintab \
$QT_CORE_SOURCES/../3rdparty/xorg \
$QT_CORE_SOURCES/../3rdparty/zlib \
$QT_CORE_SOURCES/../../doc/src/snippets \
$QT_CORE_SOURCES/../plugins/platforms \
$QT_CORE_SOURCES/../widgets/platforms

View File

@ -1,11 +0,0 @@
headerdirs +=
sourcedirs += $QT_DOC_SOURCES/doc/src
exampledirs += $QT_DOC_SOURCES/doc/src \
$QT_DOC_SOURCES \
imagedirs += $QT_DOC_SOURCES/doc/src/images \
$QT_DOC_SOURCES/doc/src/template/images
excludedirs += $QT_DOC_SOURCES/doc/src/snippets

View File

@ -1,13 +0,0 @@
headerdirs += $QT_LOCATION_SOURCES/..
sourcedirs += $QT_LOCATION_SOURCES/.. \
$QT_LOCATION_SOURCES/../../doc/src
exampledirs += $QT_LOCATION_SOURCES/../.. \
$QT_LOCATION_SOURCES/../../doc/src \
$QT_LOCATION_SOURCES/../../examples
imagedirs += $QT_LOCATION_SOURCES/../../doc/src/images \
$QT_LOCATION_SOURCES/../../examples
excludedirs += $QT_LOCATION_SOURCES/../../doc/src/snippets

View File

@ -1,14 +0,0 @@
headerdirs += $QT_MULTIMEDIA_SOURCES/..
sourcedirs += $QT_MULTIMEDIA_SOURCES/.. \
$QT_MULTIMEDIA_SOURCES/../../doc/src
exampledirs += $QT_MULTIMEDIA_SOURCES/../.. \
$QT_MULTIMEDIA_SOURCES/../../doc/src \
$QT_MULTIMEDIA_SOURCES/../../examples
imagedirs += $QT_MULTIMEDIA_SOURCES/../../doc/src/images \
$QT_MULTIMEDIA_SOURCES/../../examples
excludedirs += $QT_MULTIMEDIA_SOURCES/../../examples/video/snippets \
$QT_MULTIMEDIA_SOURCES/../../doc/src/snippets

View File

@ -1,13 +0,0 @@
headerdirs += $QT_ORGANIZER_SOURCES/..
sourcedirs += $QT_ORGANIZER_SOURCES/.. \
$QT_ORGANIZER_SOURCES/../../doc/src
exampledirs += $QT_ORGANIZER_SOURCES/../.. \
$QT_ORGANIZER_SOURCES/../../doc/src \
$QT_ORGANIZER_SOURCES/../../examples
imagedirs += $QT_ORGANIZER_SOURCES/../../doc/src/images \
$QT_ORGANIZER_SOURCES/../../examples
excludedirs += $QT_ORGANIZER_SOURCES/../../doc/src/snippets

View File

@ -1,18 +0,0 @@
headerdirs += $QT_PUBLISHSUBSCRIBE_SOURCES \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../plugins/declarative/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../imports/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../examples/publishsubscribe
sourcedirs += $QT_PUBLISHSUBSCRIBE_SOURCES \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../plugins/declarative/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../doc/src/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../imports/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../examples/publishsubscribe
exampledirs += $QT_PUBLISHSUBSCRIBE_SOURCES/../../doc/src/publishsubscribe \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../examples/publishsubscribe
imagedirs += $QT_PUBLISHSUBSCRIBE_SOURCES/../../doc/src/publishsubscribe/images \
$QT_PUBLISHSUBSCRIBE_SOURCES/../../examples/publishsubscribe
excludedirs += $QT_PUBLISHSUBSCRIBE_SOURCES/../imports

View File

@ -1,13 +0,0 @@
headerdirs += $QT_QML_SOURCES
sourcedirs += $QT_QML_SOURCES
exampledirs += $QT_QML_SOURCES/../.. \
$QT_QML_SOURCES/../../doc/src/examples \
$QT_QML_SOURCES/doc/snippets \
$QT_QML_SOURCES/../../examples
imagedirs += $QT_QML_SOURCES/../../doc/src/images \
$QT_QML_SOURCES/doc/images
excludedirs += $QT_QML_SOURCES/doc/snippets

View File

@ -1,19 +0,0 @@
headerdirs += $QT_QUICK_SOURCES \
$QT_QUICK_SOURCES/../particles \
$QT_QUICK_SOURCES/../imports
sourcedirs += $QT_QUICK_SOURCES \
$QT_QUICK_SOURCES/../particles \
$QT_QUICK_SOURCES/../imports \
$QT_QUICK_SOURCES/../../doc/src/examples
exampledirs += $QT_QUICK_SOURCES \
$QT_QUICK_SOURCES/../../doc/src/examples \
$QT_QUICK_SOURCES/doc/snippets \
$QT_QUICK_SOURCES/../../examples
imagedirs += $QT_QUICK_SOURCES/../../doc/src/images \
$QT_QUICK_SOURCES/../../examples \
$QT_QUICK_SOURCES/doc/images
excludedirs += $QT_QUICK_SOURCES/doc/snippets

View File

@ -1,16 +0,0 @@
headerdirs += $QT_SCRIPT_SOURCES/..
sourcedirs += $QT_SCRIPT_SOURCES/.. \
$QT_SCRIPT_SOURCES/../../doc/src
exampledirs += $QT_SCRIPT_SOURCES/../.. \
$QT_SCRIPT_SOURCES/../../doc/src \
$QT_SCRIPT_SOURCES/doc/snippets \
$QT_SCRIPT_SOURCES/../../examples
imagedirs += $QT_SCRIPT_SOURCES/../../doc/src/images \
$QT_SCRIPT_SOURCES/doc/images \
$QT_SCRIPT_SOURCES/../../examples
excludedirs += $QT_SCRIPT_SOURCES/../../doc/src/snippets \
$QT_SCRIPT_SOURCES/doc/snippets

View File

@ -1,17 +0,0 @@
# QT_SENSORS_SOURCES points to qtsensors/src/sensors
# We need to point to qtsensors/src so we can pick
# up the QML plugin
headerdirs += $QT_SENSORS_SOURCES/.. \
$QT_SENSORS_SOURCES/../../examples
sourcedirs += $QT_SENSORS_SOURCES/.. \
$QT_SENSORS_SOURCES/../../doc/src \
$QT_SENSORS_SOURCES/../../examples
exampledirs += $QT_SENSORS_SOURCES/../../examples \
$QT_SENSORS_SOURCES/../../doc/src
imagedirs += $QT_SENSORS_SOURCES/../../doc/src/images
excludedirs += $QT_SENSORS_SOURCES/../../doc/src/snippets

View File

@ -1,19 +0,0 @@
headerdirs += $QT_SERVICEFRAMEWORK_SOURCES \
$QT_SERVICEFRAMEWORK_SOURCES/../../plugins/declarative/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../imports/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../../examples/serviceframework
sourcedirs += $QT_SERVICEFRAMEWORK_SOURCES \
$QT_SERVICEFRAMEWORK_SOURCES/../../plugins/declarative/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../../doc/src/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../imports/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../../examples/serviceframework
exampledirs += $QT_SERVICEFRAMEWORK_SOURCES/../../examples \
$QT_SERVICEFRAMEWORK_SOURCES/../../doc/src/serviceframework \
$QT_SERVICEFRAMEWORK_SOURCES/../../examples/serviceframework
imagedirs += $QT_SERVICEFRAMEWORK_SOURCES/../../doc/src/serviceframework/images \
$QT_SERVICEFRAMEWORK_SOURCES/../../examples/serviceframework
excludedirs += $QT_SERVICEFRAMEWORK_SOURCES/../imports

View File

@ -1,13 +0,0 @@
headerdirs += $QT_SVG_SOURCES/..
sourcedirs += $QT_SVG_SOURCES/.. \
$QT_SVG_SOURCES/../../doc/src
exampledirs += $QT_SVG_SOURCES/../.. \
$QT_SVG_SOURCES/../../doc/src \
$QT_SVG_SOURCES/../../examples
imagedirs += $QT_SVG_SOURCES/../../doc/src/images \
$QT_SVG_SOURCES/../../examples
excludedirs += $QT_SVG_SOURCES/../../doc/src/snippets

View File

@ -1,20 +0,0 @@
headerdirs += $QT_SYSTEMINFO_SOURCES \
$QT_SYSTEMINFO_SOURCES/../../plugins/declarative/systeminfo \
$QT_SYSTEMINFO_SOURCES/../imports/systeminfo \
$QT_SYSTEMINFO_SOURCES/../../examples/systeminfo
sourcedirs += $QT_SYSTEMINFO_SOURCES \
$QT_SYSTEMINFO_SOURCES/../../plugins/declarative/systeminfo \
$QT_SYSTEMINFO_SOURCES/../../doc/src/systeminfo \
$QT_SYSTEMINFO_SOURCES/../imports/systeminfo \
$QT_SYSTEMINFO_SOURCES/../../examples/systeminfo
exampledirs += $QT_SYSTEMINFO_SOURCES/../.. \
$QT_SYSTEMINFO_SOURCES/../../doc/src/systeminfo \
$QT_SYSTEMINFO_SOURCES/../../examples/systeminfo
imagedirs += $QT_SYSTEMINFO_SOURCES/../../doc/src/systeminfo/images \
$QT_SYSTEMINFO_SOURCES/../../examples/systeminfo
excludedirs += $QT_SYSTEMINFO_SOURCES/../imports \
$QT_SYSTEMINFO_SOURCES/../../doc/src/serviceframework/snippets

View File

@ -1,13 +0,0 @@
headerdirs += $QT_VERSIT_SOURCES/..
sourcedirs += $QT_VERSIT_SOURCES/.. \
$QT_VERSIT_SOURCES/../../doc/src
exampledirs += $QT_VERSIT_SOURCES/../.. \
$QT_VERSIT_SOURCES/../../doc/src \
$QT_VERSIT_SOURCES/../../examples
imagedirs += $QT_VERSIT_SOURCES/../../doc/src/images \
$QT_VERSIT_SOURCES/../../examples
excludedirs += $QT_VERSIT_SOURCES/../../doc/src/snippets

View File

@ -1,12 +0,0 @@
headerdirs +=
sourcedirs += $QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES/doc/src
exampledirs += $QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES \
$QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES/doc/src \
$QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES/examples
imagedirs += $QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES/doc/src/images \
$QT_WEBKIT_EXAMPLES_AND_DEMOS_SOURCES/examples
excludedirs +=

View File

@ -1,12 +0,0 @@
headerdirs += $QT_WEBKIT/WebKit/qt/Api \
$QT_WEBKIT/WebKit/qt/declarative
sourcedirs += $QT_WEBKIT/WebKit/qt/Api \
$QT_WEBKIT/WebKit/qt/docs \
$QT_WEBKIT/WebKit/qt/declarative
exampledirs +=
imagedirs += $QT_WEBKIT/WebKit/qt/docs
excludedirs +=

View File

@ -1,15 +0,0 @@
headerdirs += $QT_XMLPATTERNS_SOURCES/.. \
$QT_XMLPATTERNS_SOURCES/../tools
sourcedirs += $QT_XMLPATTERNS_SOURCES/.. \
$QT_XMLPATTERNS_SOURCES/../../doc/src \
$QT_XMLPATTERNS_SOURCES/../../tools
exampledirs += $QT_XMLPATTERNS_SOURCES/../.. \
$QT_XMLPATTERNS_SOURCES/../../doc/src \
$QT_XMLPATTERNS_SOURCES/../../examples
imagedirs += $QT_XMLPATTERNS_SOURCES/../../doc/src/images \
$QT_XMLPATTERNS_SOURCES/../../examples
excludedirs += $QT_XMLPATTERNS_SOURCES/../../doc/src/snippets

View File

@ -1,2 +1,49 @@
include(qtdoc-project.qdocconf)
include(qt-html-templates.qdocconf)
include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include(compat.qdocconf)
include(macros.qdocconf)
project = qtdoc
description = Qt Reference Documentation
url = http://qt-project.org/doc/qt-5.0/
version = 5.0.0
depends += \
qt3d \
qtbluetooth \
qtconcurrent \
qtcontacts \
qtcore \
qtfeedback \
qtgui \
qtlocation \
qtmultimedia \
qtnetwork \
qtopengl \
qtorganizer \
qtprintsupport \
qtpublishsubscribe \
qtqml \
qtquick \
qtscript \
qtsensors \
qtserviceframework \
qtsql \
qtsysteminfo \
qttestlib \
qtversit \
qtwidgets \
qtxml \
qtxmlpatterns
headerdirs += ../src
imagedirs += ../src/images
sourcedirs += \
../.. \
../src
exampledirs += \
../.. \
../src

View File

@ -1,148 +0,0 @@
#####################################################################
# Qt documentation build
#####################################################################
DOCS_GENERATION_DEFINES =
qtPrepareTool(GENERATOR, qhelpgenerator)
qtPrepareTool(QDOC, qdoc)
win32:!win32-g++* {
unixstyle = false
} else :win32-g++*:isEmpty(QMAKE_SH) {
unixstyle = false
} else {
unixstyle = true
}
NEWLINE = $$escape_expand(\\n\\t)
$$unixstyle {
SET =
SEP =
} else {
SET = set
SEP = $$NEWLINE
}
# The module names correspond to the names of files in qtbase/mkspecs/modules
# that take the form qt_<module>.pri. This is why we see clucene, not qttools,
# and systeminfo, not systems.
MODULES = activeqt \
core \ # dbus gui network opengl openvg sql testlib uilib uitools xml
declarative \
doc \
clucene \ # help designer
location \
multimedia \
publishsubscribe \
3d \
qml \
quick \
script \ # scripttools
sensors \
serviceframework \
systeminfo \
svg \
webkit \
webkit-examples-and-demos \
xmlpatterns \
contacts \
organizer \
versit \
bluetooth
# Pretend there is a doc module. Simplifies things a bit.
QT.doc.sources = $$dirname(PWD)
# Compile a list of location definitions for each of the modules and a list of
# qdocconf files to include.
LOCATIONS =
INCLUDES =
for(module, MODULES) {
INCLUDES += $$SET
# Take the module name and convert it to the name of the variable that
# contains the sources path, which takes the form, QT.<module name>.sources.
module_name = $$upper($$module)
module_name = $$replace(module_name, "-", "_")
module_value = $$eval(QT.$$replace(module, "-", "_").sources)
!isEmpty(module_value) {
LOCATIONS += $$SET
LOCATIONS += QT_$${module_name}_SOURCES=$$module_value$$SEP
INCLUDES += QT_$${module_name}_QDOCCONF=modules/qt$${module}.qdocconf$$SEP
debug : message($$module : $$module_value)
} else {
INCLUDES += QT_$${module_name}_QDOCCONF=modules/missing.qdocconf$$SEP
debug : message($$module not found.)
}
}
# Input files in the source tree
ONLINE_QDOCCONF = $${QT.doc.sources}/doc/config/qt-build-docs-online.qdocconf
DITA_QDOCCONF = $${QT.doc.sources}/doc/config/qt-ditaxml.qdocconf
OFFLINE_QDOCCONF = $${QT.doc.sources}/doc/config/qt-build-docs.qdocconf
MODULE_ONLINE_QDOCCONF = $${QT.doc.sources}/doc/config/$${MODULE}-online.qdocconf
MODULE_OFFLINE_QDOCCONF = $${QT.doc.sources}/doc/config/$${MODULE}.qdocconf
# Output files in the build tree
QHP_FILE = html/qt.qhp
QCH_FILE = qch/qt.qch
INDEX_FILE = html/qt.index
INDEX_DEST = $$INDEX_DESTDIR/qt.index
MODULE_QHP_FILE = html/$${MODULE}.qhp
MODULE_QCH_FILE = qch/$${MODULE}.qch
MODULE_INDEX_FILE = html/$${MODULE}.index
MODULE_INDEX_DEST = $$INDEX_DESTDIR/$${MODULE}.index
COMMAND_ENV = $$LOCATIONS $$INCLUDES $$SET MODULE_SOURCE_TREE=$${QT.doc.sources}$$SEP $$SET MODULE_BUILD_TREE=$$shadowed($$QT.doc.sources)$$SEP
COMMAND = $$QDOC $$DOCS_GENERATION_DEFINES
# Build rules:
online_docs.commands = $$COMMAND_ENV $$COMMAND $$ONLINE_QDOCCONF
dita_docs.commands = $$COMMAND_ENV $$COMMAND $$DITA_QDOCCONF
docs.commands = $$COMMAND_ENV $$COMMAND $$ONLINE_QDOCCONF
# Install rules
htmldocs.files = html
htmldocs.path = $$[QT_INSTALL_DOCS]
htmldocs.CONFIG += no_check_exist directory no_default_install
docimages.files = src/images
docimages.path = $$[QT_INSTALL_DOCS]/src
QMAKE_EXTRA_TARGETS += online_docs docs dita_docs
INSTALLS += htmldocs docimages
# Rules for QCH docs, which depend on qhelpgenerator
isEmpty(GENERATOR) {
message("qhelpgenerator is not available. Documentation for use with Qt Assistant and Qt Creator cannot be generated.")
} else {
qch_docs.commands = ( $$COMMAND_ENV $$COMMAND $$OFFLINE_QDOCCONF && \
$$GENERATOR -platform minimal $$QHP_FILE -o $$QCH_FILE)
qchdocs.files = qch
qchdocs.path = $$[QT_INSTALL_DOCS]
qchdocs.CONFIG += no_check_exist directory no_default_install
QMAKE_EXTRA_TARGETS += qch_docs
INSTALLS += qchdocs
docs.commands = $$COMMAND_ENV $$COMMAND $$OFFLINE_QDOCCONF $$NEWLINE \
$$GENERATOR -platform minimal $$QHP_FILE -o $$QCH_FILE $$NEWLINE \
$$COMMAND_ENV $$COMMAND $$ONLINE_QDOCCONF
}

View File

@ -1,2 +1,12 @@
TEMPLATE = subdirs
include(doc.pri)
TEMPLATE = aux
QMAKE_DOCS = $$PWD/config/qtdoc.qdocconf
# FIXME: Refactor into load(qt_docs) or something similar
# that can be used from all non-module projects that also
# provide modularized docs, for example qmake.
QTDIR = $$[QT_HOST_PREFIX]
exists($$QTDIR/.qmake.cache): \
QMAKE_DOCS_OUTPUTDIR = $$QTDIR/doc/qtdoc
else: \
QMAKE_DOCS_OUTPUTDIR = $$OUT_PWD/qtdoc

View File

@ -1,21 +1,2 @@
TEMPLATE = subdirs
SUBDIRS = doc # demos
# Doc rules
online_docs.CONFIG = recursive
online_docs.recurse_target = online_docs
online_docs.recurse = doc
dita_docs.CONFIG = recursive
dita_docs.recurse_target = dita_docs
dita_docs.recurse = doc
qch_docs.CONFIG = recursive
qch_docs.recurse_target = qch_docs
qch_docs.recurse = doc
docs.commands = @echo $$shell_quote(Please use specific targets for monolithic docs (online_docs, dita_docs, qch_docs))
QMAKE_EXTRA_TARGETS += online_docs qch_docs docs dita_docs