diff options
| author | Olivier De Cannière <olivier.decanniere@qt.io> | 2025-08-05 15:08:39 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2025-08-07 16:23:43 +0000 |
| commit | 2f32727e0f9aed3d3bd6b7ae56f0d445559d4846 (patch) | |
| tree | 79fd83acf16c9327cc10f89ec8a427d2eeee67eb | |
| parent | d7f4a7f49e2cbe813e4f57517b6f95ed0736d3bc (diff) | |
Doc: Mention all_qmllint in the doc for qmllint6.9
This should help bring more awareness to it for people who already know
qmllint.
Pick-to: 6.8 6.5
Change-Id: I60e6c6cd1bcab349587904bce08f66af5aef3d95
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
(cherry picked from commit cb966fc7a4575065a372e0064129468193d1a9b9)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit f0252f02d0951a749b267f1bb1b84cb656dd1778)
| -rw-r--r-- | src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc b/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc index 3bc0527fe4..09f09529aa 100644 --- a/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc +++ b/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc @@ -11,10 +11,10 @@ anti-patterns. \e qmllint is a tool shipped with Qt, that verifies the syntatic validity of -QML files. -It also warns about some QML anti-patterns. If you want to disable a specific -warning type, you can find the appropriate flag for doing so by passing -\c{--help} on the command line. +QML files. You can \l{Using qmllint with CMake}{integrate qmllint into your build system} +for ease of use. It also warns about some QML anti-patterns. If you want to +disable a specific warning type, you can find the appropriate flag for doing so +by passing \c{--help} on the command line. By default, some issues will result in warnings that will be printed. If there are more warnings than a limit which can be configured with \c{--max-warnings}, @@ -55,6 +55,11 @@ qmllint can warn you about code that cannot be compiled by \l{qmlsc}. These warnings are not enabled by default. In order to enable them specify \c{--compiler warning} or adjust your settings file accordingly. +\section2 Using qmllint with CMake +For projects using the \l{qt6_add_qml_module}{qt_add_qml_module()} CMake API for creating QML +modules, \l{Linting QML sources}{convenience targets} such as \c all_qmllint are created +automatically. These run qmllint on all the QML files of a specific module or of the project. + \section2 Marking components and properties as deprecated qmllint allows you to mark both properties and components as deprecated: |