aboutsummaryrefslogtreecommitdiffstats
path: root/src/qmlcompiler/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove qml-i18n example in qtdeclarative repoAlexandru Croitor2025-10-311-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | The qml-i18n example and the qtdeclarative repo itself depend on the LinguistTools CMake package, which is not available while building qtdeclarative. This results in: - missing build coverage for the example - a cyclic dependency, because qtdeclarative depends on qttools (because of LinguistTools), and qttools depends on qtdeclarative (because of qdoc needs) - we try to find a module that will never be available, unless qtdeclarative is built together with qttools in a top-level build - in certain cases, if the top-level build fails early enough, the cyclic dependency causes reconfigurations to fail Remove the example, the lookup of LinguistTools, and the linguist doc references to avoid all these issues. Replace the qt_add_translations reference in the docs of the QQmlApplicationEngine class with a snippet copy. Pick-to: 6.8 6.10 Task-number: QTBUG-141465 Change-Id: Id88603a3753f53dfac9f350e981073effda15eb1 Reviewed-by: Masoud Jami <masoud.jami@qt.io>
* Doc: Unify spelling of Qt Qml modulesJaishree Vyas2025-06-053-8/+8
| | | | | | | Fixes: QTBUG-132703 Pick-to: 6.9 6.10 Change-Id: Iee8cd7415d7e5c088f0b43786326c8339b46490a Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
* Docs: Reorganize the qml tooling pageAlexei Cazacov2024-11-012-6/+6
| | | | | | | Task-number: QTBUG-130111 Pick-to: 6.8 Change-Id: I4e6d9f35a12ec5c74625e955d40b80d470dd6253 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
* Docs: Organize topics in the qtdeclarative/Qt Qml Compiler projectAlexei Cazacov2024-07-253-2/+32
| | | | | | | | | | This commit organizes the articles, so they: - have a reasonable tree structure - can be navigated through the topic tree in the Qt Creator help viewer Task-number: QTBUG-126648 Change-Id: Iafd5d3d63c2cc775a825b93bbe0409d3df233c7b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* doc: change names of qmllint and qmlls pagesSami Shalayel2024-02-272-6/+6
| | | | | | | | | | | | | | | | | Make the names of the qmllint and qmlls pages unique by appending "Reference". This is in-line with what we do in other places of the documentation, see also the `Qt Creator Manual` page that is used to link to `Qt Creator` This fixes the problem of \l{QML Language Server} linking to a subsection instead to linking to the `QML Language Server Reference` page. Task-number: QTBUG-121134 Pick-to: 6.7 Change-Id: I187042d1825d10ea59b5c3af96b8f5fdce10fa9b Reviewed-by: Semih Yavuz <semih.yavuz@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix linking issues and missing QDoc commandsTopi Reinio2024-01-061-1/+1
| | | | | | | | | | | | | | | Fix multiple incorrect \l (link) command arguments that were not captured by documentation testing in CI. Add missing \endqml and \endcode commands to code snippets. Convert \sa commands that are meant to be related to specific \section commands into manual 'See also' paragraphs. Otherwise, they are listed at the bottom of the page. Pick-to: 6.7 Change-Id: Icf2a97f63b8b8cdec2d9398448d28759dabdb06b Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* QQmlSA: Add initial fixit sectionFabian Kosmale2023-11-281-0/+12
| | | | | | | | | | | | | | FixSuggestion unfortunately still lacks class documentation, and we probably need to rework the API before moving the module out of TP. However, we should still show the basic usage of the module, including fixit suggestions. Consequently, add a small example on how to write FixSuggestions, and add a warning note that they should only be marked as auto-applicable if the resulting code is still valid. Pick-to: 6.6 Change-Id: I260021163e3afe2cda97fd82a9bf4e9c26a910e2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* QmlCompiler: restructure docFabian Kosmale2023-11-262-6/+43
| | | | | | | | | | - align structure with other index pages - reference the actul compilers - link to tutorial Pick-to: 6.6 Change-Id: Ibc98c846f83638595f5752f3a0d342bcf1e1aa10 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* QQmlSa: Start custom qmllint plugin tutorialFabian Kosmale2023-11-242-0/+219
| | | | | | | Pick-to: 6.6 Change-Id: I34e692f46c752a52ee42669c5431f4d546009e65 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Vladimir Minenko <vladimir.minenko@qt.io>
* Doc: Fix undocumented parameters and broken linksTopi Reinio2023-09-151-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * src/qml/jsapi/qjsengine.cpp: (qdoc) warning: Can't link to 'qvariant_cast()' * src/quick/items/qquickrhiitem.cpp: (qdoc) warning: Undocumented parameter 'item' in QQuickRhiItemRenderer::synchronize() (qdoc) warning: Can't link to 'msaaColorBuffer()' (qdoc) warning: Can't link to 'resolveTexture()' * src/quick/scenegraph/util/qsgtextnode.cpp: (qdoc) warning: No such enum item 'Text.NativeRendering' in QSGTextNode::RenderType (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setColor() (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setSelectionColor() (qdoc) warning: Undocumented parameter 'viewport' in QSGTextNode::setViewport() * examples/quick/rendercontrol/rendercontrol_rhi/doc/src/ rendercontrol_rhi.qdoc: (qdoc) warning: Can't link to 'QWidget-based' (qdoc) warning: Can't link to 'QAnimationDriver' Mark all documentation modules in qtdeclarative as free of warnings. Change-Id: I97cc059701c351b53cdeeb5fc2feff923c5a76a8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+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: I7e5be717195049a6ce1d0a10ccbb1daeb175d714 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Qt QML Compiler: Add .qhp subprojectTopi Reinio2023-06-021-0/+6
| | | | | | | | Add a subproject that lists classes and namespaces. Task-number: QTBUG-114163 Change-Id: If1ff32de4418fbb55ea0a1e375396ef00fad72e9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* QmlCompiler: Add some qhp configurationUlf Hermann2023-06-021-0/+14
| | | | | | | Fixes: QTBUG-114163 Change-Id: I0d47e11a3aa7ba2a523d359040f8e4489704fc4e Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* QQmlSA: Create an abstraction layer for static analysisOlivier De Cannière2023-05-303-0/+84
This patch adds abstractions for QML Elements, Bindings, Methods and Properties. This abstraction layer avoids exposing internal details and should be more suited for static analysis tasks. It is now possible to write qmllint plugins without including private headers. As a drive-by, change tst_qmllint:verifyJsRoot to open files in text mode instead of binary. This fixes an issue where line endings cause issues on Windows. Fixes: QTBUG-102276 Change-Id: I6b6e53f1e0078734a18f3aa51807fbe875b375f0 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-01 23:02:17 +0000