Commit 71c6bddd authored by Oswald Buddenhagen's avatar Oswald Buddenhagen

integrate developer docs into the normal docs build

Change-Id: Ie94fe37f9025643c35c14a224661295e6c4c9a41
Reviewed-on: http://codereview.qt.nokia.com/288Reviewed-by: default avatarQt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: default avatarDaniel Teske <daniel.teske@nokia.com>
parent 8cabf8a2
TEMPLATE = app
TARGET = apidoc
CONFIG -= qt
QT =
LIBS =
macx:CONFIG -= app_bundle
isEmpty(vcproj) {
QMAKE_LINK = @: IGNORE THIS LINE
OBJECTS_DIR =
win32:CONFIG -= embed_manifest_exe
} else {
CONFIG += console
PHONY_DEPS = .
phony_src.input = PHONY_DEPS
phony_src.output = phony.c
phony_src.variable_out = GENERATED_SOURCES
phony_src.commands = echo int main() { return 0; } > phony.c
phony_src.name = CREATE phony.c
phony_src.CONFIG += combine
QMAKE_EXTRA_COMPILERS += phony_src
}
include(../../qtcreator.pri)
QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)
VERSION_TAG = $$replace(QTCREATOR_VERSION, "[-.]", )
srcdir = $$cleanPath($$PWD/..)
equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys
QDOC = SRCDIR=$$srcdir OUTDIR=$$OUT_PWD/html QTC_VERSION=$$QTCREATOR_VERSION QTC_VERSION_TAG=$$VERSION_TAG $$QDOC_BIN
} else:win32-g++* { # just mingw
# The lack of spaces in front of the && is necessary!
QDOC = set SRCDIR=$$srcdir&& set OUTDIR=$$OUT_PWD/html&& set QTC_VERSION=$$QTCREATOR_VERSION&& set QTC_VERSION_TAG=$$VERSION_TAG&& $$QDOC_BIN
} else { # nmake
QDOC = set SRCDIR=$$srcdir $$escape_expand(\\n\\t) \
set OUTDIR=$$OUT_PWD/html $$escape_expand(\\n\\t) \
set QTC_VERSION=$$QTCREATOR_VERSION $$escape_expand(\\n\\t) \
set QTC_VERSION_TAG=$$VERSION_TAG $$escape_expand(\\n\\t) \
$$QDOC_BIN
}
HELP_FILES = $$PWD/qtcreator-dev.qdocconf
HELP_DEP_FILES = $$PWD/qtcreator-api.qdoc \
$$PWD/coding-style.qdoc \
$$PWD/external-tool-spec.qdoc \
$$PWD/qtcreator-dev.qdoc \
$$PWD/qtcreator-dev-wizards.qdoc \
$$PWD/qtcreator-dev.qdocconf
docs.name = CREATE API DOC
docs.input = HELP_FILES
docs.output = $$OUT_PWD/index.html
docs.depends = $$HELP_DEP_FILES
win32:docs.commands = $$QDOC \"${QMAKE_FILE_IN}\"
unix:docs.commands = $$QDOC ${QMAKE_FILE_IN}
docs.CONFIG += no_link
isEmpty(vcproj):docs.variable_out = PRE_TARGETDEPS
QMAKE_EXTRA_COMPILERS += docs
......@@ -3,17 +3,20 @@ HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)
VERSION_TAG = $$replace(QTCREATOR_VERSION, "[-.]", )
equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys
QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html QTC_VERSION=$$QTCREATOR_VERSION QTC_VERSION_TAG=$$VERSION_TAG $$QDOC_BIN
} else:win32-g++* { # just mingw
# The lack of spaces in front of the && is necessary!
QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& set QTC_VERSION=$$QTCREATOR_VERSION&& set QTC_VERSION_TAG=$$VERSION_TAG&& $$QDOC_BIN
} else { # nmake
QDOC = set SRCDIR=$$PWD $$escape_expand(\\n\\t) \
set OUTDIR=$$OUT_PWD/doc/html $$escape_expand(\\n\\t) \
set QTC_VERSION=$$QTCREATOR_VERSION $$escape_expand(\\n\\t) \
set QTC_VERSION_TAG=$$VERSION_TAG $$escape_expand(\\n\\t) \
$$QDOC_BIN
defineReplace(qdoc) {
equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys
QDOC = SRCDIR=$$PWD OUTDIR=$$1 QTC_VERSION=$$QTCREATOR_VERSION QTC_VERSION_TAG=$$VERSION_TAG $$QDOC_BIN
} else:win32-g++* { # just mingw
# The lack of spaces in front of the && is necessary!
QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$1&& set QTC_VERSION=$$QTCREATOR_VERSION&& set QTC_VERSION_TAG=$$VERSION_TAG&& $$QDOC_BIN
} else { # nmake
QDOC = set SRCDIR=$$PWD $$escape_expand(\\n\\t) \
set OUTDIR=$$1 $$escape_expand(\\n\\t) \
set QTC_VERSION=$$QTCREATOR_VERSION $$escape_expand(\\n\\t) \
set QTC_VERSION_TAG=$$VERSION_TAG $$escape_expand(\\n\\t) \
$$QDOC_BIN
}
return($$QDOC)
}
QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp
......@@ -29,30 +32,53 @@ HELP_DEP_FILES = $$PWD/qtcreator.qdoc \
$$PWD/config/qt-html-default-styles.qdocconf \
$$PWD/qtcreator.qdocconf
html_docs.commands = $$QDOC $$PWD/qtcreator.qdocconf
html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator.qdocconf
html_docs.depends += $$HELP_DEP_FILES
html_docs.files = $$QHP_FILE
html_docs_online.commands = $$QDOC $$PWD/qtcreator-online.qdocconf
html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online.qdocconf
html_docs_online.depends += $$HELP_DEP_FILES
qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
qch_docs.depends += html_docs
DEV_QHP_FILE = $$OUT_PWD/doc/api/html/qtcreator-dev.qhp
DEV_QCH_FILE = $$IDE_DOC_PATH/qtcreator-dev.qch
DEV_HELP_DEP_FILES = \
$$PWD/api/qtcreator-api.qdoc \
$$PWD/api/coding-style.qdoc \
$$PWD/api/external-tool-spec.qdoc \
$$PWD/api/qtcreator-dev.qdoc \
$$PWD/api/qtcreator-dev-wizards.qdoc \
$$PWD/api/qtcreator-dev.qdocconf
dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/api/html) $$PWD/api/qtcreator-dev.qdocconf
dev_html_docs.depends += $$DEV_HELP_DEP_FILES
dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/api/html) $$PWD/api/qtcreator-dev-online.qdocconf
dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES
dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE
dev_qch_docs.depends += dev_html_docs
unix:!macx {
inst_qch_docs.files = $$QCH_FILE
inst_qch_docs.path = /share/doc/qtcreator
inst_qch_docs.CONFIG += no_check_exist
INSTALLS += inst_qch_docs
inst_dev_qch_docs.files = $$DEV_QCH_FILE
inst_dev_qch_docs.path = /share/doc/qtcreator
inst_dev_qch_docs.CONFIG += no_check_exist
INSTALLS += inst_dev_qch_docs
}
docs_online.depends = html_docs_online
docs.depends = qch_docs
QMAKE_EXTRA_TARGETS += html_docs html_docs_online qch_docs docs docs_online
docs_online.depends = html_docs_online dev_html_docs_online
docs.depends = qch_docs dev_qch_docs
QMAKE_EXTRA_TARGETS += html_docs dev_html_docs html_docs_online dev_html_docs_online qch_docs dev_qch_docs docs docs_online
OTHER_FILES = $$HELP_DEP_FILES \
$$PWD/api/qtcreator-api.qdoc \
$$PWD/api/qtcreator-api.qdocconf
OTHER_FILES = $$HELP_DEP_FILES $$DEV_HELP_DEP_FILES
fixnavi.commands = \
cd $$targetPath($$PWD) && \
......
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