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

77 lines
2.5 KiB
Plaintext
Raw Normal View History

Doc: remove space from value of project variable This is a new qdoc requirement for the project variable in qdocconf files. Change-Id: I23d921bac68e3c2948c4193b08a60c756e258ccc Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-05-31 13:28:14 +02:00
project = "QtCreator"
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
description = "Qt Creator Manual"
Adapt documentation URL Change-Id: I74963a9d4a729450341f4f7a4ae5b3583654ffb8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-02-18 10:20:03 +01:00
url = http://doc.qt.io/qtcreator
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: 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 =
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
sourcedirs = ../src
imagedirs = ../images \
../templates/images \
../../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/formeditor \
../../src/plugins/qmldesigner/components/navigator \
../../src/plugins/scxmleditor/common/images \
../../src/plugins/texteditor/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: 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
HTML.extraimages = images/commercial.png
qhp.QtCreator.extraFiles = images/commercial.png
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
depends += qtwidgets \
qtcore \
qtqml \
qtquick \
qmake \
qtdesigner \
qtdoc \
qtgui \
qthelp \
qtquickcontrols \
qtquickcontrols2 \
qtquickextras \
qtlinguist \
qtscxml \
qtsensors \
qttestlib \
qtuitools \
qtxml
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
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
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
qhp.QtCreator.file = qtcreator.qhp
Replace com.nokia.qtcreator with org.qt-project.qtcreator Task-number: QTCREATORBUG-8189 Change-Id: I1c882f55eed901620ef4944bf1789645b7cff34a Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2013-01-29 15:29:55 +01:00
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
Doc: add version numbers to the doc titles Change-Id: I2b71cba2ab19a15a834976e3ce953e992ca4b124 Reviewed-by: David Boddie Reviewed-on: http://codereview.qt.nokia.com/640 Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
2011-06-22 17:24:57 +02:00
qhp.QtCreator.indexTitle = Qt Creator Manual $QTC_VERSION
Fix Qt Creator version in documentation again.
2011-03-07 20:38:17 +01:00
qhp.QtCreator.filterAttributes = qtcreator $QTC_VERSION
qhp.QtCreator.customFilters.QtCreator.name = Qt Creator $QTC_VERSION
qhp.QtCreator.customFilters.QtCreator.filterAttributes = qtcreator $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
qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
Doc: Move the TOC to a separate page that is used as indexTitle value This fixes the problem that the whole TOC is not visible in the Qt Creator Help mode Contents view (because it was generated based on the \table entries, not the \list entries). Task-number: QTCREATORBUG-10585 Change-Id: I86607e10db7172b2a7492e4ce1660c39390ef9ed Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-03-08 16:27:22 +01:00
qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator TOC
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
navigation.landingpage = "Qt Creator Manual"
buildversion = "Qt Creator Manual $QTC_VERSION"
Copy Permalink