summaryrefslogtreecommitdiffstats
path: root/doc/src/platformintegration
Commit message (Collapse)AuthorAgeFilesLines
* Update link for Wayland QPAEskil Abrahamsen Blomfeldt2023-10-191-1/+1
| | | | | | | | | | | We should have a specialized "Linux/Wayland" page, like we do for the other QPA backends, but until we do, have the Wayland QPA link to the general page about Wayland and Qt rather than the Wayland compositor. Task-number: QTBUG-118111 Pick-to: 6.5 6.6 Change-Id: I59305c268bf372303b8b817d8fa65e38dd237779 Reviewed-by: Liang Qi <liang.qi@qt.io>
* Doc: All overviews list categorizationJaishree Vyas2023-09-111-1/+1
| | | | | | | | | | | | | | | | The \generate list names are added for each categorized section with some explanation. Here, calling the overviews as explanations-(name of the section). The idea is to give general terms instead of specific phrases like 'core' etc, for better understanding. Allow two warnings for \generatelist commands as the related \group pages live in modules external to qtdoc and are not loaded when testing documentation in the CI. Task-number: QTBUG-115347 Pick-to: 6.5 6.6 Change-Id: Ia8307d42fdb137808ae75cb9bcfeb58de30ba550 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: List of all Qt overviews which are now termed as explanationJaishree Vyas2023-07-191-0/+1
| | | | | | | | | | | | | The autogenerated list of overviews was adding the \group command which included all the groups instead of overviews. The idea here is to categorize the overviews later on once we have the list of all overviews. Task-number: QTBUG-114762 Pick-to: 6.5 6.6 Change-Id: I7dd312258c27662354a7b0f59f947ca82317f53f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-4/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: I51cccfed5fe4ff27c99cb280db1f0959be16df1d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove OpenWF and Mir clients from list of QPA pluginsVolker Hilsheimer2023-04-041-8/+0
| | | | | | | | | They never made it into Qt 6. Pick-to: 6.2 6.5 Change-Id: I858e2b2d7c0b04077f2c8f0c0820f94ff93c9ec7 Reviewed-by: Janne Koskinen <janne.p.koskinen@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add local includepath to Qt Platform Integration projectTopi Reinio2022-12-141-0/+1
| | | | | | | | | | | The documentation project attempts to use the file platformintegration.h as the module header but the include path is not set, leading QDoc to construct an artificial one. Pick-to: 6.5 Change-Id: I5ef444028e0fce98b164ddd5b97f7b503f26b8c7 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove \inheaderfile commands that take no argumentsTopi Reinio2022-08-311-2/+0
| | | | | | | | The command expects an argument and QDoc warns if one is not given. Pick-to: 6.4 Change-Id: Id0747b869ce2d149854f92cf9797bf7f33aea21f Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-08-231-1/+1
| | | | | | | Task-number: QTBUG-105718 Change-Id: Iec124e0bceb4335370674a222970cd9c1b90763f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Mention ways to select a QPA plugin in QPA overviewKai Köhne2022-07-201-0/+7
| | | | | | | Pick-to: 6.4 Change-Id: I5204a4733f88ed0225ba001d016bdab406fddc77 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: David Skoland <david.skoland@qt.io>
* Add license headers to cmake filesLucie Gérard2022-07-071-0/+3
| | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Existing copyright statements remain intact Task-number: QTBUG-88621 Change-Id: I9499ba4c20f610ffe8af0fc3e29e6581247f2c40 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-073-78/+6
| | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: Idfd176b7f7b077a5b7c66b7738dc9bcac94ab290 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Use simpler names for documentation targetsKai Köhne2022-01-121-2/+2
| | | | | | | | | | | | | | Name the build targets like the project, without a 'doc' attached. This way, you can now e.g. run ninja html_docs_qtcmake instead of ninja html_docs_CMakeDoc Change-Id: I817e8ad91e8646c17cc7b7ffad70fa2b415668f4 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: Enable zero warning limitVenugopal Shivashankar2021-11-151-0/+4
| | | | | Change-Id: I157ef93d8a5c07528de267fe51ea9ed7f161a7ee Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix link errors qtdocNico Vertriest2020-11-191-1/+1
| | | | | | | Task-number: QTBUG-86800 Change-Id: I3c9c8c10ed593601b25026b1f25be16390d2e50d Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add CMake build config for Platform Integration docsTopi Reinio2020-11-161-0/+7
| | | | | Change-Id: I8c347ec7fb140119c4e3e9fa8084e2e2e3d6d854 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove WebGL platform docsLaszlo Agocs2020-11-101-4/+0
| | | | | | | This is gone in Qt 6. Change-Id: Id4dbe854c46e8a03c9963b777a471e5332bd438f Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Omit references to Qt Multimedia from qtdocPaul Wicking2020-11-042-4/+4
| | | | | | | | | | As Qt Multimedia is not released with Qt 6.0, omit references to it from qtdoc. Add missing tags to \omit and \endomit commands, to make it easier to discover and revert these changes at a later time. Task-number: QTBUG-86800 Change-Id: I44606de846cd33f0ac50a103482896794733fe12 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Add QSGTexture to list of native interfacesTor Arne Vestbø2020-10-291-0/+6
| | | | | Change-Id: Iff715e013434f49d07bb119e4e977aba84c31504 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add native interface overview documentationTor Arne Vestbø2020-10-204-1/+145
| | | | | Change-Id: Id3474406e289c0f336d60ba3b715344c869439b3 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Rename PlatformIntegration documentation projectTopi Reinio2020-10-162-1/+1
| | | | | | | | | | The name of the .qdocconf file must match the lower-cased 'project' variable, otherwise qhelpgenerator does not find the generated .qhp file. Fixes: QTBUG-87673 Change-Id: I7c7829b8c86553819c630e307c9c25ce0be2f428 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Add native event handling docsTor Arne Vestbø2020-10-151-0/+15
| | | | | Change-Id: Ia862c57a04c0ed978bdcbdfd5cc29b67b5ea59d1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add Qt Quick dependency to platform integration docsTor Arne Vestbø2020-10-152-2/+2
| | | | | Change-Id: I0f23c094a1d394c6700f61e1d7cb943f4e19f0ad Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add window embedding platform documentationTor Arne Vestbø2020-10-152-1/+19
| | | | | Change-Id: If47518a560a12a8af38019ab105240011a1ba876 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Fix dependencies in platform integration docsTor Arne Vestbø2020-10-151-6/+2
| | | | | Change-Id: I5d457610b3d270f00c7125a5668ba18676687f2a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add platform type conversions documentationTor Arne Vestbø2020-10-142-0/+55
| | | | | | Change-Id: I2e1a27d027f6110ed4e63f391cd7ceaff6c4d9b8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* First steps towards documenting our platform APIsTor Arne Vestbø2020-10-144-0/+286
Adds a new top level topic for platform integration, moving the QPA docs under that, and cleans up and rewrites the QPA docs for Qt 6. Task-number: QTBUG-80233 Change-Id: I658e5e2c402a25ce391102675cee6ada0563e71f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>