feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
dfadc17cb59cf479fe48b5cb15bf3d6bebb023eb
qt-creator/doc/qtcreator/config/qtcreator-project.qdocconf

104 lines
3.6 KiB
Plaintext
Raw Normal View History

Doc: Fix naming of .index files Qt Creator Manual and Extending Qt Creator had the same project name, and therefore the same index file name. Also qdoc's "depends" configuration requires the index file to have the same name as the directory. Adapt the project names accordingly. Change-Id: Ie1ec8ede360e19e3ffd5c7dbea44344f0a631f68 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-05-22 10:53:08 +02:00
project = qtcreator
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
description = "$IDE_DISPLAY_NAME Manual"
url = http://doc.qt.io/$IDE_ID
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
Doc: Add list to words to ignore for automatic linking Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 14:43:02 +02:00
#Words to ignore for auto-linking
ignorewords += \
macOS \
WebChannel \
WebSocket \
WebSockets \
OpenGL \
MinGW
Doc: WS fix in qdocconf file. Change-Id: I57767dbf8c5af8f2961136cb9a7ca16dab6fcf5b Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-06-24 13:48:15 +02:00
headerdirs =
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
sourcedirs = ../src \
../../qtdesignstudio/src/qtquick3d-editor
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
imagedirs = ../images \
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
../../qtdesignstudio/images \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../../src/libs/qmleditorwidgets/images \
../../../src/libs/utils/images \
../../../src/plugins/android/images \
../../../src/plugins/autotest/images \
../../../src/plugins/classview/images \
../../../src/plugins/coreplugin/images \
../../../src/plugins/debugger/images \
../../../src/plugins/diffeditor/images \
../../../src/plugins/help/images \
../../../src/plugins/projectexplorer/images \
../../../src/plugins/qmldesigner/components/componentcore/images \
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
../../../src/plugins/qmldesigner/components/edit3d/images \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../../src/plugins/qmldesigner/components/formeditor \
../../../src/plugins/qmldesigner/components/navigator \
../../../src/plugins/qmldesigner/components/timelineeditor/images \
Doc: Describe Positioner and Layout type properties Move positioning to a separate topic. The information in this topic is related not only to the Library view, but also to the Properties and Form Editor views. Describe the properties of the Positioner and Layout types. Change-Id: I9d00bc9498499f52ecf49463df7f651aaecf8f0e Reviewed-by: Alessandro Portale <alessandro.portale@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-10-02 12:07:15 +02:00
../../../src/plugins/qmldesigner/componentsplugin/images \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../../src/plugins/qmldesigner/qmlpreviewplugin/images \
Doc: Describe properties of Studio Components (shapes) And the basic Rectangle. Fixes: QDS-2848 Change-Id: I6a0f506ed1f1c0ec3d065823131e7eb48445c6e2 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-10-01 16:48:17 +02:00
../../../src/plugins/qmldesigner/qtquickplugin/images \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../../src/plugins/scxmleditor/common/images \
../../../src/plugins/texteditor/images \
../../../src/plugins/valgrind/images \
../../../src/plugins/welcome/images
Doc: Use icons from source in the manual This removes the need to take screenshots of icons. - Add icon source directories for the .qdocconf file - Remove screenshots of icons from doc\images (except completion icons) - Copy images that do not have unique names from src or libs to \docs\images - Create images that use overlays and update them in docs\images - Fix paths and filenames in \inlineimage commands - Fix text where one screenshot was replaced by two icons Change-Id: Ib98206890bd15a843566de8d709e45487c70dfbd Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
2016-05-03 13:49:23 +02:00
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
exampledirs = ../examples
Doc: update the mobile application tutorial Update text to match the template and UI. Use the \example command instead of \page to have qdoc generate HTML files from the example files. This requires also adding the .pro file. Add an SVG image to the sources and link to it from the text. Change-Id: Ib90798386ee082c9ea2a405b33a4f2a5996a9d2a Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-06-29 14:49:40 +02:00
examples.fileextensions += *.qml *.svg
Doc: Remove non-existent path from .qdocconf Path 'snippets' does not exist. Change-Id: I3cd5a426f4916e7cb5c7868f8bf437de8e59389c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-08-14 14:42:23 +02:00
Doc: Fix the \youtube macro for use with liteHTML help backend Create a common directory for extra image files, and move the video thumbnails there. This folder structure is required to work around the fact that relative image paths passed to qhp.<project>.extraFiles are not resolved correctly when loading the generated help project. Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 18:21:33 +01:00
include(../../qtcreator/images/extraimages/qtcreator-extraimages.qdocconf)
Doc: add a "commercial" icon to commercial-only topics For purely commercial apps, this is done by using the template, but Qt Creator is mostly open source, so an image is used. Use a \commercial macro with a tooltip and link to the image. Change-Id: I5e3df953821551331afef2ec642b482b52ff909e Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-04-08 12:43:38 +02:00
Doc: Fix links to QtAndroid functions Add a dependency to the Qt Android Extras module to the doc configuration file to enable linking to the module. Change-Id: I69271554f78a0d73fc44032f9310e9670b06961e Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-04-20 12:10:19 +02:00
depends += qtandroidextras\
qtwidgets \
Doc: Add dependency to qtcmake for links to CMake docs to work Fixes a QDoc warning. Change-Id: I7248cbc6471830039f6399696416de40ceacb595 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-12-17 16:04:40 +01:00
qtcmake \
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
qtcore \
qtqml \
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
qtqmlmodels \
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
qtquick \
qmake \
qtdesigner \
qtdoc \
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
qtgraphicaleffects \
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
qtgui \
qthelp \
Doc: Describe Qt Quick Designer 3D editor - Pull source files from /doc/qtdesignstudio/srcqtquick3d-editor - Add the necessary defines to link to additional Qt modules - Use the same structure and files for the Qt Quick Designer parts as in Qt Design Studio Manual - Move some overviews to /doc/qtcreator folder - Fix the TOC and the navigation links Change-Id: I2103a8e635e537fd276b3e14feeb8f50beb92cae Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 09:36:22 +01:00
qtquick3d \
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
qtquickcontrols \
qtquickextras \
Doc: Update info about enabling the Timeline view in Qt Creator Qt Quick Timeline module is delivered with Qt 5.14 and later. Change-Id: I5666fa0fd190607a1bb6224dcff5ac7f39db61f7 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-10-25 15:09:27 +02:00
qtquicktimeline \
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
qtlinguist \
qtscxml \
qtsensors \
qttestlib \
qtuitools \
Doc: Update information about developing for Android devices - Users can now add images to use as splash screens. - Restructure the information to promote the automatic setup. - Remove obsolete and duplicate information. - Move external links to external-resources file. Change-Id: I9578ff8615bb2a0db528f45276d16a838554b143 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-08-06 09:58:46 +02:00
qtxml \
Doc: Use version independent Qt link or use direct links where possible. Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-04 16:46:45 +01:00
qtlocation \
qtvirtualkeyboard
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
include(../../config/macros.qdocconf)
include(../../config/qt-cpp-ignore.qdocconf)
include(../../config/qt-defines.qdocconf)
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
Doc: Use defines to enable hiding device-related information Currently, only Android and embedded Linux devices are supported by Qt Design Studio. Change-Id: I10005f6a9cfeb93c99447796c1c9e6d47ab578de Reviewed-by: Vikas Pachdha <vikas.pachdha@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-15 15:21:48 +02:00
defines += qtcreator
Doc: change doc configuration after moving files to subdirectories Change-Id: I6df3222a92efed43ede601e3f2e6f71b75782d22 Reviewed-on: http://codereview.qt-project.org/5602 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 11:21:21 +02:00
sources.fileextensions = "*.qdoc"
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
qhp.projects = QtCreator
Fix documentation build when renaming IDE Do not rename documentation qhp file. The documentation qmake files currently depend on the files having the same base name as the qdocconf file. Also do not change the documentation namespace. There are places where these are mentioned in translated strings. Fixup of 54208113eee147b29a7a7c4df96365569890fd56 Change-Id: Iace171535ea5be6e22fec9760a5d96722b052341 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-06-21 14:08:59 +02:00
qhp.QtCreator.file = qtcreator.qhp
qhp.QtCreator.namespace = org.qt-project.qtcreator.$QTC_VERSION_TAG
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
qhp.QtCreator.virtualFolder = doc
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
qhp.QtCreator.indexTitle = $IDE_DISPLAY_NAME Manual $QTC_VERSION
qhp.QtCreator.filterAttributes = $IDE_ID $QTC_VERSION
qhp.QtCreator.customFilters.QtCreator.name = $IDE_DISPLAY_NAME $QTC_VERSION
qhp.QtCreator.customFilters.QtCreator.filterAttributes = $IDE_ID $QTC_VERSION
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
qhp.QtCreator.indexRoot =
qhp.QtCreator.subprojects = manual
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
qhp.QtCreator.subprojects.manual.title = $IDE_DISPLAY_NAME Manual
Doc: Add a link to a site map (TOC) listing all topics Change-Id: Ibb71a67874d0146298c6bbed420549660426e0ca Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-24 09:58:06 +02:00
qhp.QtCreator.subprojects.manual.indexTitle = All Topics
Updated the configuration files to use the updated qdoc. Updated qdoc to remove hard-coded dependencies on style sheets. Simplified the offline documentation, introducing an offline.css file to be used for documentation in Qt Creator.
2010-12-17 20:21:27 +01:00
qhp.QtCreator.subprojects.manual.type = manual
# Doxygen compatibility commands
macro.see = "\\sa"
macro.function = "\\fn"
Doc: Get Creator and Extending manuals to use new qdocconf variables. -navigation variables for Qt 5.2's navigation bar -buildversion is for including specific build information such as branch name and patch version Change-Id: I4d36f1ea73b8c37ab787d154c9fdd91650305bc5 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-06-19 12:20:43 +02:00
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
navigation.landingpage = "$IDE_DISPLAY_NAME Manual"
buildversion = "$IDE_DISPLAY_NAME Manual $QTC_VERSION"
Copy Permalink