Commit 276320ca authored by Oswald Buddenhagen's avatar Oswald Buddenhagen

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: default avatarLeena Miettinen <riitta-leena.miettinen@digia.com>
parent 4cf40725
# Run qdoc from the directory that contains this file.
include(../config/compat.qdocconf)
include(qtcreator-dev-online.qdocconf)
# Run qdoc from the directory that contains this file.
include(../config/compat.qdocconf)
include(qtcreator-dev.qdocconf)
...@@ -46,7 +46,6 @@ outputdir = $OUTDIR ...@@ -46,7 +46,6 @@ outputdir = $OUTDIR
exampledirs = $SRCDIR/api/examples exampledirs = $SRCDIR/api/examples
indexes = qt.index indexes = qt.index
include(compat.qdocconf)
include(macros.qdocconf) include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf) include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf) include(qt-defines.qdocconf)
......
...@@ -9,7 +9,6 @@ exampledirs = $SRCDIR/examples \ ...@@ -9,7 +9,6 @@ exampledirs = $SRCDIR/examples \
$SRCDIR/snippets $SRCDIR/snippets
indexes = qt.index indexes = qt.index
include(compat.qdocconf)
include(macros.qdocconf) include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf) include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf) include(qt-defines.qdocconf)
......
greaterThan(QT_MAJOR_VERSION, 4) { greaterThan(QT_MAJOR_VERSION, 4) {
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal
QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc) QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc)
COMPAT =
} else { } else {
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator) HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)
QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3) QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)
COMPAT = -qt4
} }
...@@ -33,13 +35,13 @@ HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \ ...@@ -33,13 +35,13 @@ HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \
$$PWD/config/qt-defines.qdocconf \ $$PWD/config/qt-defines.qdocconf \
$$PWD/config/qt-html-templates.qdocconf \ $$PWD/config/qt-html-templates.qdocconf \
$$PWD/config/qt-html-default-styles.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.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE 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 html_docs_online.depends += $$HELP_DEP_FILES
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
...@@ -59,12 +61,12 @@ DEV_HELP_DEP_FILES = \ ...@@ -59,12 +61,12 @@ DEV_HELP_DEP_FILES = \
$$PWD/api/first-plugin.qdoc \ $$PWD/api/first-plugin.qdoc \
$$PWD/api/plugin-specifications.qdoc \ $$PWD/api/plugin-specifications.qdoc \
$$PWD/api/plugin-lifecycle.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.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_html_docs_online.depends += $$DEV_HELP_DEP_FILES
dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE
......
# Run qdoc from the directory that contains this file.
include(config/compat.qdocconf)
include(qtcreator-online.qdocconf)
# Run qdoc from the directory that contains this file.
include(config/compat.qdocconf)
include(qtcreator.qdocconf)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment