aboutsummaryrefslogtreecommitdiffstats
path: root/doc/config
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Move Qt Bridge product name macros to the common macros fileLeena Miettinen2020-05-141-0/+3
| | | | | | | ..from the Qt Design Studio Manual doc configuration file. Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Fix qdoc call after it moved to LLVM/ClangEike Ziller2020-02-171-2/+1
| | | | | | | | | | | | | | | | | 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>
* Doc: Rearrange files in the doc folderLeena Miettinen2020-01-273-186/+0
| | | | | | | | | | | | | | | | 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>
* Doc: Add dependency to qtcmake for links to CMake docs to workLeena Miettinen2019-12-181-0/+1
| | | | | | | Fixes a QDoc warning. Change-Id: I7248cbc6471830039f6399696416de40ceacb595 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update info about Clang toolsLeena Miettinen2019-11-251-1/+2
| | | | | Change-Id: I86fecea5e5bc6d1b514cca4b8ad7a865cbf87c7e Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
* Doc: Update info about enabling the Timeline view in Qt CreatorLeena Miettinen2019-10-281-0/+1
| | | | | | | Qt Quick Timeline module is delivered with Qt 5.14 and later. Change-Id: I5666fa0fd190607a1bb6224dcff5ac7f39db61f7 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Describe using Qt Design ViewerLeena Miettinen2019-10-251-0/+1
| | | | | | | | For running Qt Quick UI projects (.qmlproject) in web browsers. Change-Id: Ied9b971755ccef9f94e9e0ffb578d3ecbd0ef6c0 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Add info on Live PreviewLeena Miettinen2019-07-111-0/+1
| | | | | | | | | The documentation was moved from the Qt Design Studio repository and edited to make it applicable to Qt Creator, too. Change-Id: I3072fc712b5ee002cd6e7486927de31f9117d7bc Reviewed-by: Brook Cronin <brook.cronin@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
* Doc: Fix the path to Timeline editor imagesLeena Miettinen2019-07-021-1/+1
| | | | | | | The icon files were moved to a new location. Change-Id: I45b2ed9e78cb9fd3b00a75a37598df2beba745e2 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Move Timeline editor docs to the Qt Creator repositoryLeena Miettinen2019-05-031-0/+1
| | | | | | | | | Reorganize the Qt Quick Designer docs. Change-Id: I844f2ffa6c8337eef1d9aa5dbd23610c706a8c33 Reviewed-by: Brook Cronin <brook.cronin@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
* Doc: Replace "Qt Quick Controls 2" with "Qt Quick Controls"Leena Miettinen2019-04-091-1/+0
| | | | | | | | | | | - Qt Quick Controls 1 has been removed and most link targets have been changed - Leave some link targets where links would break - Leave strings that still have the "2" in Qt Creator - Remove the obsolete dependency (QDoc complained about it) Change-Id: I05148df3b07b4499f802557252c028b11ca29213 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Describe launching KCachegrind from Qt CreatorLeena Miettinen2019-04-051-1/+2
| | | | | | | ...for profile data visualization. Change-Id: I878ab4a3dfff0fc43903e482603a516514e79c10 Reviewed-by: hjk <hjk@qt.io>
* Doc: Describe converting Qt Quick UI Prototypes to ApplicationsLeena Miettinen2019-01-161-0/+1
| | | | | | | | | | | | Qt Quick UI Prototype projects (.qmlproject) are used in Qt Design Studio, but they must be converted to Qt Quick Application projects for building and running them in Qt Creator. Add example files and quote code from them. Task-number: QDS-357 Change-Id: Ib0bf1b342ec54faeca108e5586389730a85b5116 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* Doc: Use defines to enable hiding device-related informationLeena Miettinen2018-08-161-0/+2
| | | | | | | | | 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>
* Fix documentation build when renaming IDEEike Ziller2018-07-041-2/+2
| | | | | | | | | | | | | | 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>
* Pass IDE_DISPLAY_NAME et al to qdoc and use it for manualEike Ziller2018-06-202-14/+14
| | | | | Change-Id: I5d52c9561d4c49df503c0e99c8765979516e5b5c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add a link to a site map (TOC) listing all topicsLeena Miettinen2018-05-251-1/+1
| | | | | Change-Id: Ibb71a67874d0146298c6bbed420549660426e0ca Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-14 21:07:46 +0000