aboutsummaryrefslogtreecommitdiffstats
path: root/doc/config
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Describe the new toolbar in Qt Quick DesignerLeena Miettinen2017-05-041-0/+1
| | | | | | | | | | Some regularly used context-menu items can now be selected on the toolbar. Some of the icons are constructed at runtime, so images are needed for them. Some are in a new location that has to be added to the configuration file. Change-Id: Ibfc38ec21ed5526702abf89e64899efa5b978700 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Remove dependencies to deprecated modulesLeena Miettinen2017-03-232-3/+0
| | | | | | | To suppress QDoc warnings. Change-Id: Ic1eb077701d9e9bdcaee63af9af8eaff8d2ec26f Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Create a reusable docs.pri for generating documentationEike Ziller2017-03-092-59/+56
| | | | | | | | | | | 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>
* Doc: Move the TOC to a separate page that is used as indexTitle valueLeena Miettinen2017-03-091-1/+1
| | | | | | | | | | 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>
* Doc: Remove unused QTC_LICENSE_TYPE defineEike Ziller2017-03-061-2/+1
| | | | | Change-Id: Iba49e6fc6b1d857cc0f87b5bf833f42a4a8a976f Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Add docs for SCXML EditorLeena Miettinen2016-10-061-0/+1
| | | | | Change-Id: I563a2a06b101e3954c3365baba4a596ef29517ab Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Remove reference to obsolete qtquicklayouts.index fileLeena Miettinen2016-08-191-1/+0
| | | | | | | | Add a link to the Layout QML type and fix the name of the import to stop an autolink from being generated to the wrong target. Change-Id: Id2ca5e418ea6d254813a20f00b6623ff21dda09a Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Introduce a macro \macos to adapt to upcoming renamingshjk2016-08-031-0/+1
| | | | | | | | | Start with an initial value 'macOS' and use in uncontroversial places in the docs. Some explicit references to older versions are untouched in this patch. Change-Id: Ibea4115c45fc2ff2c9a0518d92797df26fd4138f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update creating components and screens with Qt Quick DesignerLeena Miettinen2016-07-291-0/+1
| | | | | | | Add dependency to the Qt Quick Controls 2 docs Change-Id: Idcbb856cf38d8867dc781ade572cf18f87983912 Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
* Doc: Describe model and state chart wizardsLeena Miettinen2016-07-271-0/+1
| | | | | | | | Add the Qt SCXML index file to be able to link to the module docs. Change-Id: Ibd28071cdc3c98c07fb91c73732d809ffed5333b Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Icons: Move "next/prev", "[un]locked" and "zoom" from Core to UtilsAlessandro Portale2016-05-311-0/+1
| | | | | | | | | | They are needed in the timeline view. The change in qtcreator-project.qdocconf makes sure that qdoc still finds the referenced icons. Change-Id: I812fba8e57d06d93efc00c295467c83c08cd1784 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
* Doc: Use icons from source in the manualLeena Miettinen2016-05-031-1/+15
| | | | | | | | | | | | | | | | 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>
* Doc: Extending Qt Creator Manual: Fix documentation configTopi Reinio2016-01-261-4/+2
| | | | | | | | | | - Add missing sourcedir (../api) to get landing page and other documentation generated. - Remove invalid sourcedirs (Find and Locator plugin directories no longer exist). Change-Id: I125e86702eaded08de342e103970281984f449d4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Remove codeindent from documentation configurationTopi Reinio2015-12-091-2/+0
| | | | | | | | | | A default indent of 1 was defined for code snippets. It was overridden by the template, and most likely left there as an oversight. Now, with QDoc and the templates from Qt 5.6 it does have an effect, and makes the style look worse and copy-pasting code more cumbersome. Change-Id: I37a0facd4c03566eaf295a2cc391fa328f50c14d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: add docs for ISO Icon BrowserLeena Miettinen2015-10-271-0/+1
| | | | | | | | | | A commercial Qt Quick Designer plugin for adding ISO 7000 icons to applications from an icon library. Change-Id: I96d740d63bc77da9817ce2d5ccdb1625dbc5caa6 Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com> Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
* Doc: fix section name in the sidebar in online docsLeena Miettinen2015-09-071-1/+1
| | | | | | | | "Debugging and Analyzing" is now "Testing", because autotests are also described in this section. Change-Id: Ied1de78d630e4e7faa39d343475b5e493b5e89c7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: remove references to Qt WebKitLeena Miettinen2015-08-101-1/+0
| | | | | | | It has been deprecated and was only used as an example. Change-Id: I4e483e2f86b32476e4b88c9c3eecb7eeffa42e72 Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
* Doc: update the mobile application tutorialLeena Miettinen2015-06-301-1/+1
| | | | | | | | | | | | | | 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>
* Doc: add UI Forms tutorialLeena Miettinen2015-06-261-0/+1
| | | | | | | Based on the Qt Quick Controls UI Forms example. Change-Id: Iec42b7559161f980e4f482c63bfc40a22f5e77f8 Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
* Doc: add a "commercial" icon to commercial-only topicsLeena Miettinen2015-04-083-0/+5
| | | | | | | | | | | | 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>
* Doc: experimental Auto Test pluginLeena Miettinen2015-04-081-0/+1
| | | | | | | Commercial only. Change-Id: Id2ee9a7765f226c32ec1595e32f4b53ee94d1207 Reviewed-by: Christian Stenger <christian.stenger@theqtcompany.com>
* Adapt documentation URLSergio Ahumada2015-02-181-1/+1
| | | | | Change-Id: I74963a9d4a729450341f4f7a4ae5b3583654ffb8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Prepare Qt Creator manual for the qt.io online styleTopi Reinio2014-11-241-0/+17
| | | | | | | | | - Add a copyright notice (required for projects external to Qt in the new template) - Add an .html file with sidebar content Change-Id: I2c9d965698aa2d2ed01426510b16916ed4fef8cf Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: remove support for building docs with Qt 4Leena Miettinen2014-11-246-427/+18
| | | | | | | | | The templates are fetched from qtbase/doc/global Change-Id: I15386a66e1dae552f5637062d9f176bf6565a834 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Remove non-existent path from .qdocconfTopi Reinio2014-08-141-2/+2
| | | | | | | Path 'snippets' does not exist. Change-Id: I3cd5a426f4916e7cb5c7868f8bf437de8e59389c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* QmlProfiler: Update documentationUlf Hermann2014-07-041-0/+1
| | | | | | | | | Quite a few things have changed and the documentation should describe them correctly. Change-Id: I21a1f81022f21500c069b641744a37eef9eaa6b9 Task-number: QTCREATORBUG-12590 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Adding Qt Creator's URL in qt-project.org in qdocconf file.Jerome Pasion2014-07-041-0/+1
| | | | | | | | -can be used for referencing Qt Creator's pages from other QDoc projects. Change-Id: Ifdb82a8995976580876523f5bd6efb688bdfb9b1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* fix building against non-installed qt5 shadow buildsOswald Buddenhagen2014-05-271-17/+17
| | | | | | | | | | | | | the global qdoc configs may live in the source dir, but the indexes are always in the build dir. this will obviously only work for a non-prefix (developer) build of qt, as a non-installed prefix build is not usable from the outside. Task-number: QTCREATORBUG-11919 Change-Id: I268af2f075a098ac5fe788a2f85c754dc6e4e8b0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
* Doc: remove Qt Simulator macroLeena Miettinen2014-03-141-1/+0
| | | | | | | The Qt Simulator is no longer mentioned in the docs. Change-Id: I8730e45c75f2e69dadc053ebfa205aa7b6eef5fd Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: don't use the term SDK in connection with QtLeena Miettinen2014-03-141-1/+1
| | | | | | | | | | | Replace with "Qt distributions" or "installers" or rewrite in some other way. Remove references to installing Qt 4 SDK, because it is no longer available for downloading. Change-Id: I291f82702e21d953f2efbb0e634d6454b4bc17b9 Reviewed-by: hjk <hjk121@nokiamail.com>
* Incremented year in copyright infoRobert Loehning2014-01-082-2/+2
| | | | | | Change-Id: Ib5423fdd064e4546f848c0b640b0ed0514c26d3a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: use cross-linking to Qt module documentationLeena Miettinen2013-11-261-1/+14
| | | | | | | | | | | | | | | | Replace links to "\l{http://qt-project.org/doc/" with links to topic titles. Remove links where QDoc creates them automatically based on the .index files. Add the .index files for the modules that are discussed in the Qt Creator Manual. Note: the links will only be generated if the Qt used to build the docs contains the linked modules and documentation (.index file) has been generated for them. Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Eike Ziller <eike.ziller@digia.com>
* Doc: point the automatic links to Qt 5 docsLeena Miettinen2013-11-061-1/+4
| | | | | | | | | | The index files are now fetched from qt5/qtbase/doc. Removed the qt.index file that came from Q 4. When building the docs with Qt 4, no links will be generated automatically. Change-Id: I0786745f218e4c854e08012664629a7697dcadf3 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
* Merge remote-tracking branch 'origin/2.8'Eike Ziller2013-06-251-2/+1
|\ | | | | | | | | | | | | Conflicts: src/plugins/fakevim/fakevimhandler.cpp Change-Id: I8101f18b87859924644471817d4f1408790d5628
| * Add documentation for extensions of Qml Performance MonitorKai Koehne2013-06-201-1/+2
| | | | | | | | | | | | | | Can be enabled by passing LICENSE_TYPE=enterprise to qmake. Change-Id: I49044c2425a056980b6e9f8377e6a33c1beaca5a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
| * Doc: remove obsolete \if defined commandsLeena Miettinen2013-06-191-3/+1
| | | | | | | | | | | | | | The doc sources are no longer used for single-sourcing. Change-Id: I934c88c19646d84b4de3c5787234148f947c4489 Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* | Doc: Get Creator and Extending manuals to use new qdocconf variables.Jerome Pasion2013-06-252-0/+6
| | | | | | | | | | | | | | | | | | | | -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>
* | Doc: WS fix in qdocconf file.Jerome Pasion2013-06-241-1/+1
|/ | | | | Change-Id: I57767dbf8c5af8f2961136cb9a7ca16dab6fcf5b Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* Hide internal API when generating API documentation.Eike Ziller2013-04-031-4/+3
| | | | | | | Knowledge why internal API was explicitly enabled is lost. Change-Id: Ie35b31f624be413405bf2f28cf97822aa687bb3d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Removing tracking code from template.Jerome Pasion2013-03-081-14/+1
| | | | | | | Task-number: QTCREATORBUG-8627 Change-Id: I7d98c15789618a16ebca024cf0a88cc9f19c378a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Replace com.nokia.qtcreator with org.qt-project.qtcreatorSergio Ahumada2013-02-072-2/+2
| | | | | | Task-number: QTCREATORBUG-8189 Change-Id: I1c882f55eed901620ef4944bf1789645b7cff34a Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: replace deprecated QDoc commandsLeena Miettinen2013-02-062-7/+7
| | | | | | | | | | The \i and \o commands were replaced with \li and \bold was replaced with \b in QDoc for Qt 5. The \input command was replaced with \include in the docs. Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* make doc generation work cleanly with both qt4 & qt5Oswald Buddenhagen2013-02-062-2/+0
| | | | | | | | qdoc does not expand variables in include() statements, so we need to use separate top-level "switch" files. Change-Id: I3152baa36cb3dee055abdc68c046b445f92e1fb9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Incremented year in copyright infov2.6.2Robert Loehning2013-01-292-2/+2
| | | | | Change-Id: Ic6a9ff0359625021ebc061d22db6811814534205 Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Doc: fix missing snippetsLeena Miettinen2013-01-231-1/+2
| | | | | | | | Add the path to the snippets folder to the qdocconf file and fix the paths in \snippet commands in the source file. Change-Id: Iebabec6919b580e6d1474685777862200d314a83 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Avoid pulling in "Extending Manual" into Qt Creator manual.Eike Ziller2012-12-171-1/+1
| | | | | | | | | | With Qt5, qdoc finds the doc/api/*.qdoc files if the examplesdir points to doc/, leading to the two toplevel index.html files ending up within qtcreator.qch Change-Id: I4ac3c1447c6924c4e292024919d52ddb97e1f8cc Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix Qt Creator manual style when generating with Qt 5.Eike Ziller2012-12-102-57/+105
| | | | | | | | | | | | The HTML.templatedir is no longer used in Qt 5. Instead, the files are resolved relative to the referencing qdocconf. So we set the templatedir to the path of the qdocconf (for Qt 4) and change the references to be relative to that path. Also, it's HTML.extraimages in Qt 5, instead of extraimages.HTML Task-number: QTBUG-28304 Change-Id: I5b253ea9fac5825c49f74460df188a7fca5c89cd Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Making the header consistent with Qt reference documentation.Jerome Pasion2012-10-231-2/+1
| | | | | Change-Id: I2272f577b707ffd2f308924ba01b768c81decaa8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* More Nokia -> Digia/QtProject changesEike Ziller2012-10-091-4/+4
| | | | | Change-Id: If52505dbc95ee48ac3467cdfbbea91629c11089c Reviewed-by: Tobias Hunger <tobias.hunger@digia.com>
* Adjust license headershjk2012-10-052-4/+4
| | | | | Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-13 05:59:32 +0000