feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
ec9a72808f039de1fe1e434f89f48ec10f91b352
qt-creator/docs.pri

58 lines
1.8 KiB
Plaintext
Raw Normal View History

Further abstract docs.pri So the same file can be used without adaptions in other projects (for example Qbs). Adds installation of the html documentation, which should not hurt, or might even be preferable. Change-Id: I8f6fbf072b348dfe13e54a5f2018ed6e24fc3a34 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-03-10 13:44:29 +01:00
# Creates targets for building Qt Creator documentation
#
# Usage: Include qtcreator.pri and define DOC_FILES to point to a list of qdocconf files,
# then include this .pri file
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
isEmpty(VERSION): error("Include qtcreator.pri before including docs.pri!")
Pass IDE_DISPLAY_NAME et al to qdoc and use it for manual Change-Id: I5d52c9561d4c49df503c0e99c8765979516e5b5c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-18 16:03:42 +02:00
qtcname.name = IDE_DISPLAY_NAME
qtcname.value = "$$IDE_DISPLAY_NAME"
qtcid.name = IDE_ID
qtcid.value = $$IDE_ID
qtccasedid.name = IDE_CASED_ID
qtccasedid.value = $$IDE_CASED_ID
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
qtcver.name = QTC_VERSION
Show "display" version number in documentation I.e. 4.3.0-rc1 instead of 4.2.83 Change-Id: I67feebc9071a8a08b5ac4c701017095e28deaa13 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-04-25 14:31:17 +02:00
qtcver.value = $$QTCREATOR_DISPLAY_VERSION
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
qtcvertag.name = QTC_VERSION_TAG
Show "display" version number in documentation I.e. 4.3.0-rc1 instead of 4.2.83 Change-Id: I67feebc9071a8a08b5ac4c701017095e28deaa13 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-04-25 14:31:17 +02:00
qtcvertag.value = $$replace(VERSION, \.,)
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
qtdocs.name = QT_INSTALL_DOCS
qtdocs.value = $$[QT_INSTALL_DOCS/src]
qdocindex.name = QDOC_INDEX_DIR
qdocindex.value = $$[QT_INSTALL_DOCS]
qtcdocsdir.name = QTC_DOCS_DIR
qtcdocsdir.value = $$IDE_SOURCE_TREE/doc
Use QTCREATOR_COPYRIGHT_YEAR for documentation For this the offline style overwrites any footer that was set in the qt-html-templates-offline.qdocconf from Qt. Change-Id: I8a8f7048445bc03a72b19df6c60b7cea680c5803 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-03-27 16:49:14 +02:00
qtccopyrightyear.name = QTCREATOR_COPYRIGHT_YEAR
qtccopyrightyear.value = $$QTCREATOR_COPYRIGHT_YEAR
add IDE_SOURCE_TREE to the doc environment we want to use images from some plugins and to reference those, we need IDE_SOURCE_TREE variable. Change-Id: Ia7e83a4d2e65ff34a839732fb24a0804aca007d9 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-07-17 17:08:14 +02:00
qtcsourcedir.name = IDE_SOURCE_TREE
qtcsourcedir.value = $$IDE_SOURCE_TREE
QDOC_ENV += qtcname \
qtcid \
qtccasedid \
qtcver \
qtcvertag \
qtdocs \
qdocindex \
qtcdocsdir \
qtccopyrightyear \
qtcsourcedir
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
Further abstract docs.pri So the same file can be used without adaptions in other projects (for example Qbs). Adds installation of the html documentation, which should not hurt, or might even be preferable. Change-Id: I8f6fbf072b348dfe13e54a5f2018ed6e24fc3a34 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-03-10 13:44:29 +01:00
DOC_INDEX_PATHS += $$IDE_BUILD_TREE/doc
DOC_HTML_INSTALLDIR = $$INSTALL_DOC_PATH
DOC_QCH_OUTDIR = $$IDE_DOC_PATH
DOC_QCH_INSTALLDIR = $$INSTALL_DOC_PATH
Create a reusable docs.pri for generating documentation Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-02 15:55:08 +01:00
Fix qdoc call after it moved to LLVM/Clang For some unknown reason qdoc does not add the include paths for Qt modules, so we need to do that manually. Also, if we do that, we need to pass it the default include paths, so standard C++ headers are found. Qt includes and standard headers are found now, but Framework style includes on macOS still fail ("QtCore/QString"), which are used in Qt headers as well. Looks like the framework path that is passed with -F to qdoc is not passed on correctly. Task-number: QTCREATORBUG-22451 Change-Id: I04b2c75ecdeb1f0e70ba9adfea039f0ff16ec96b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-05-20 15:07:29 +02:00
minQtVersion(5, 11, 0) {
for (include_path, INCLUDEPATH): \
DOC_INCLUDES += -I $$shell_quote($$include_path)
for (module, QT) {
MOD_INCLUDES = $$eval(QT.$${module}.includes)
for (include_path, MOD_INCLUDES): \
DOC_INCLUDES += -I $$shell_quote($$include_path)
}
for (include_path, QMAKE_DEFAULT_INCDIRS): \
DOC_INCLUDES += -I $$shell_quote($$include_path)
macos: DOC_INCLUDES += -F $$shell_quote($$[QT_INSTALL_LIBS])
}
Further abstract docs.pri So the same file can be used without adaptions in other projects (for example Qbs). Adds installation of the html documentation, which should not hurt, or might even be preferable. Change-Id: I8f6fbf072b348dfe13e54a5f2018ed6e24fc3a34 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-03-10 13:44:29 +01:00
include(doc/doc_targets.pri)
Copy Permalink