aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorOswald Buddenhagen <oswald.buddenhagen@digia.com>2013-02-05 17:08:54 +0100
committerOswald Buddenhagen <oswald.buddenhagen@digia.com>2013-02-06 09:40:03 +0100
commit276320caac4f0fd6399974a15a636a92ea6a7cfa (patch)
treed21021ab250f8bcae91772def12b6a0c79fcc98b /doc
parent4cf407252c23717269003f2ec8a9af3204cb30da (diff)
make doc generation work cleanly with both qt4 & qt5
qdoc does not expand variables in include() statements, so we need to use separate top-level "switch" files. Change-Id: I3152baa36cb3dee055abdc68c046b445f92e1fb9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/qtcreator-dev-online-qt4.qdocconf4
-rw-r--r--doc/api/qtcreator-dev-qt4.qdocconf3
-rw-r--r--doc/config/qtcreator-developer.qdocconf1
-rw-r--r--doc/config/qtcreator-project.qdocconf1
-rw-r--r--doc/doc.pri14
-rw-r--r--doc/qtcreator-online-qt4.qdocconf3
-rw-r--r--doc/qtcreator-qt4.qdocconf3
7 files changed, 21 insertions, 8 deletions
diff --git a/doc/api/qtcreator-dev-online-qt4.qdocconf b/doc/api/qtcreator-dev-online-qt4.qdocconf
new file mode 100644
index 0000000000..0bd7edcb2a
--- /dev/null
+++ b/doc/api/qtcreator-dev-online-qt4.qdocconf
@@ -0,0 +1,4 @@
+# Run qdoc from the directory that contains this file.
+include(../config/compat.qdocconf)
+include(qtcreator-dev-online.qdocconf)
+
diff --git a/doc/api/qtcreator-dev-qt4.qdocconf b/doc/api/qtcreator-dev-qt4.qdocconf
new file mode 100644
index 0000000000..55cc6987f9
--- /dev/null
+++ b/doc/api/qtcreator-dev-qt4.qdocconf
@@ -0,0 +1,3 @@
+# Run qdoc from the directory that contains this file.
+include(../config/compat.qdocconf)
+include(qtcreator-dev.qdocconf)
diff --git a/doc/config/qtcreator-developer.qdocconf b/doc/config/qtcreator-developer.qdocconf
index 4e5637abff..a2c8a101e0 100644
--- a/doc/config/qtcreator-developer.qdocconf
+++ b/doc/config/qtcreator-developer.qdocconf
@@ -46,7 +46,6 @@ outputdir = $OUTDIR
exampledirs = $SRCDIR/api/examples
indexes = qt.index
-include(compat.qdocconf)
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf
index e0eb7ce797..dd1792f278 100644
--- a/doc/config/qtcreator-project.qdocconf
+++ b/doc/config/qtcreator-project.qdocconf
@@ -9,7 +9,6 @@ exampledirs = $SRCDIR/examples \
$SRCDIR/snippets
indexes = qt.index
-include(compat.qdocconf)
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
diff --git a/doc/doc.pri b/doc/doc.pri
index 8a970a38f1..d70ceb8f8b 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -1,9 +1,11 @@
greaterThan(QT_MAJOR_VERSION, 4) {
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal
QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc)
+ COMPAT =
} else {
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)
QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)
+ COMPAT = -qt4
}
@@ -33,13 +35,13 @@ HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \
$$PWD/config/qt-defines.qdocconf \
$$PWD/config/qt-html-templates.qdocconf \
$$PWD/config/qt-html-default-styles.qdocconf \
- $$PWD/qtcreator.qdocconf
+ $$PWD/qtcreator$${COMPAT}.qdocconf
-html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator.qdocconf
+html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator$${COMPAT}.qdocconf
html_docs.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE
-html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online.qdocconf
+html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online$${COMPAT}.qdocconf
html_docs_online.depends += $$HELP_DEP_FILES
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
@@ -59,12 +61,12 @@ DEV_HELP_DEP_FILES = \
$$PWD/api/first-plugin.qdoc \
$$PWD/api/plugin-specifications.qdoc \
$$PWD/api/plugin-lifecycle.qdoc \
- $$PWD/api/qtcreator-dev.qdocconf
+ $$PWD/api/qtcreator-dev$${COMPAT}.qdocconf
-dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev.qdocconf
+dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev$${COMPAT}.qdocconf
dev_html_docs.depends += $$DEV_HELP_DEP_FILES
-dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online.qdocconf
+dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online$${COMPAT}.qdocconf
dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES
dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE
diff --git a/doc/qtcreator-online-qt4.qdocconf b/doc/qtcreator-online-qt4.qdocconf
new file mode 100644
index 0000000000..c0b201dae7
--- /dev/null
+++ b/doc/qtcreator-online-qt4.qdocconf
@@ -0,0 +1,3 @@
+# Run qdoc from the directory that contains this file.
+include(config/compat.qdocconf)
+include(qtcreator-online.qdocconf)
diff --git a/doc/qtcreator-qt4.qdocconf b/doc/qtcreator-qt4.qdocconf
new file mode 100644
index 0000000000..7805ce924b
--- /dev/null
+++ b/doc/qtcreator-qt4.qdocconf
@@ -0,0 +1,3 @@
+# Run qdoc from the directory that contains this file.
+include(config/compat.qdocconf)
+include(qtcreator.qdocconf)