summaryrefslogtreecommitdiffstats
path: root/doc/global/includes
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix path of qt-cmake on WindowsKai Köhne5 days1-1/+1
| | | | | | | | Path changed in Qt sometime before 6.8. Pick-to: 6.10 6.9 6.8 Change-Id: I5335d0eed1428801bed77e762b82d69ffb2437f8 Reviewed-by: Joerg Bornemann <[email protected]>
* Doc: Update \externalpage entries for Qt Creator documentationLeena Miettinen2024-08-021-3/+3
| | | | | | | | | | - The docs were restructured in v. 13.0 and 14.0, so most headings changed, some topics were removed and lots of topics were added - Use the macro \QC - Fix the broken links in qtbase Change-Id: Ic173a3e9a1c80322162c3feb277098de2a9f1cc6 Reviewed-by: Topi Reiniö <[email protected]>
* Doc: Fix wrong markup in QStandardPaths::findExecutableKai Köhne2023-11-291-5/+5
| | | | | | Pick-to: 6.6 Change-Id: Ia9b9752a7d73b8695f2be227d7fe78e6da927a2e Reviewed-by: Leena Miettinen <[email protected]>
* Add StateLocation & GenericStateLocation to StandardLocationJonathan Ketchker2023-09-071-1/+3
| | | | | | | | | | | | | | | | | | | | | The latest XDG spec (0.8) defines XDG_STATE_HOME that does not exist in QStandardPaths::StandardLocation. Some Linux distributions clean XDG_CACHE_HOME on restart which makes XDG_STATE_HOME useful as a path for saving application state. This commit adds StateLocation and GenericStateLocation to serve as a StandardLocation for XDG_STATE_HOME for all platforms. This commit also updates docs and tests to fit the new changes. [ChangeLog][QStandardPaths] Added StateLocation & GenericStateLocation to StandardLocation Change-Id: I470602466c37f085062cc64d15ea243711728fa5 Reviewed-by: David Faure <[email protected]> Reviewed-by: Qt CI Bot <[email protected]> Reviewed-by: Thiago Macieira <[email protected]>
* Doc: explicitly mention C++ when discussing linking to C++ librariesMitch Curtis2023-01-311-3/+4
| | | | | | | Fixes: QTBUG-108325 Pick-to: 6.2 6.4 6.5 Change-Id: I7282c8a8df0bf8f403a4e7a9d4512e7bdf6c9979 Reviewed-by: Kai Köhne <[email protected]>
* Move the docs for porting to QRegularExpression to a common placeSona Kurazyan2022-07-201-0/+175
| | | | | | | | | | | Copy them from QRegExp docs in qt5compat to doc/global/includes/corelib/port-from-qregexp.qdocinc, so that the porting docs can be included from both Qt 6 porting guide and qt5compat. Task-number: QTBUG-89702 Pick-to: 6.4 6.3 6.2 Change-Id: I616e2333f60f36e4851398479939fd062016748d Reviewed-by: Edward Welbourne <[email protected]>
* Use SPDX license identifiersLucie Gérard2022-05-163-78/+6
| | | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1 Reviewed-by: Qt CI Bot <[email protected]> Reviewed-by: Lars Knoll <[email protected]> Reviewed-by: Jörg Bornemann <[email protected]>
* Doc: Use \QtVersion macro to display correct version in code snippetTopi Reinio2022-03-141-2/+2
| | | | | | | | Pick-to: 6.3 Fixes: QTBUG-100770 Change-Id: Iec0e91bfb98781e63e5379bd0aa67d37df7c6cac Reviewed-by: Luca Di Sera <[email protected]> Reviewed-by: Venugopal Shivashankar <[email protected]>
* Doc: Add \include snippets with optional parametersAndreas Eliasson2022-02-281-1/+36
| | | | | | | | | | | | | | | | | | There are many different wordings for how to use the module across the module landing pages. The goal here is to provide consistent wording and code formatting, which can be used across all landing pages. The style and wording is based on what has been implemented in the Qt CoAP module landing page. This is the syntax in a qdoc file: \include {module-use.qdoc} {<snippet-id>} {<argument1>} Inside qdocinc, you can then get the value of the argument1 using the parameter \1. Task-number: QTBUG-100369 Change-Id: Ib25e509e119008157e69db629eb011e5a9074022 Pick-to: 6.3 Reviewed-by: Kai Koehne <[email protected]>
* Doc: Update Notepad tutorialLeena Miettinen2022-01-312-2/+68
| | | | | | | | | Update to use Qt Creator 7.0 and CMake as the build system. Fixes: QTBUG-100075 Pick-to: 6.3 Change-Id: I71e1d1446a2c79c98423ca5d4427b4b4eb00021b Reviewed-by: Venugopal Shivashankar <[email protected]>
* Document that QStandardPath::findExecutable works with absolute pathsAlbert Astals Cid2022-01-211-0/+3
| | | | | | Change-Id: Ib993fa9a5f2c68febac9820e241c8617bb8ba5bc Pick-to: 6.3 6.2 5.15 Reviewed-by: Thiago Macieira <[email protected]>
* Doc: Fix reference to Qt5 CMake packageKai Koehne2020-11-191-1/+1
| | | | | Change-Id: I5abd63727d6578cb30c6d11228777e4bd9bf91b7 Reviewed-by: Paul Wicking <[email protected]>
* Remove usage of deprecated QStandardPaths::DataLocationKarsten Heimrich2020-10-231-1/+1
| | | | | | | | | * Rearrange the documention to match the enumeration order. Fixes: QTBUG-87037 Change-Id: Iad001351e0f309e694b8bbd503813017e6586a21 Reviewed-by: Mitch Curtis <[email protected]> Reviewed-by: Alex Blasche <[email protected]>
* Doc: Move the common documentation to a qdocincVenugopal Shivashankar2019-11-181-0/+129
| | | | | | | | | | The member functions of QStandardPath and Qt.labs.platform.StandardPath behave the same, so it's ideal to maintain their documentation in one place. Task-number: QTBUG-79827 Change-Id: I349dbb85cd9b6a3bedac329c0707fc07057cd64b Reviewed-by: Paul Wicking <[email protected]>
* Document how to use CMake on Qt Core, Qt GUI's central pagesKai Koehne2019-05-071-0/+52
| | | | | | | | | | | | | | | Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. Separate generic info from module-specific examples, to make it possible to use one include file in all modules. While at it, also remove the mentioning of the central include; it is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92 Reviewed-by: Leena Miettinen <[email protected]>
* Doc: Add a section all modules can use for example documentation.Jerome Pasion2014-04-091-0/+5
-modules that use the qt-module-defaults.qdocconf have access to the .qdocinc file. -content about running examples can be used by example documentation. Task-number: QTBUG-33597 Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2 Reviewed-by: Topi Reiniö <[email protected]> Reviewed-by: Leena Miettinen <[email protected]>
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-12 11:16:25 +0000