aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSemih Yavuz <semih.yavuz@qt.io>2023-10-09 13:55:41 +0200
committerSemih Yavuz <semih.yavuz@qt.io>2023-10-12 17:38:32 +0200
commit58479248662f0de26b8962093fbe9fee20c79a2c (patch)
treec0a7a3e12769b9e93536f3330752ff99b4249864
parenta569a9c941fd72f070645f220316ce94dad89a74 (diff)
doc: Move qmllint and qmlls docs out of qtquick folder
The documentation for QML tools should live in qml/doc. As todo for next commit: Introduce qmltooling overview page and exhibit qml tools in categories like developer-tools, designer-tools, internal-tools etc. Task-number: QTBUG-116660 Change-Id: Ide3b0a306e34dd6c1466dfdfa836d073caf1c884 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
-rw-r--r--src/qml/doc/snippets/qmllint/config.ini (renamed from src/quick/doc/snippets/qmllint/config.ini)0
-rw-r--r--src/qml/doc/src/qtqml-tooling-qmllint.qdoc (renamed from src/quick/doc/src/guidelines/qtquick-tool-qmllint.qdoc)3
-rw-r--r--src/qml/doc/src/qtqml-tooling-qmlls.qdoc (renamed from src/quick/doc/src/guidelines/qtquick-tool-qmlls.qdoc)2
-rw-r--r--src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc2
4 files changed, 4 insertions, 3 deletions
diff --git a/src/quick/doc/snippets/qmllint/config.ini b/src/qml/doc/snippets/qmllint/config.ini
index 29fa21438a..29fa21438a 100644
--- a/src/quick/doc/snippets/qmllint/config.ini
+++ b/src/qml/doc/snippets/qmllint/config.ini
diff --git a/src/quick/doc/src/guidelines/qtquick-tool-qmllint.qdoc b/src/qml/doc/src/qtqml-tooling-qmllint.qdoc
index c54fb81cc7..ed7e35db77 100644
--- a/src/quick/doc/src/guidelines/qtquick-tool-qmllint.qdoc
+++ b/src/qml/doc/src/qtqml-tooling-qmllint.qdoc
@@ -2,8 +2,9 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
-\page qtquick-tool-qmllint.html
+\page qtqml-tooling-qmllint.html
\title qmllint
+\ingroup explanations-tools
\brief A tool for verifying the syntax of QML files and warning about
anti-patterns.
diff --git a/src/quick/doc/src/guidelines/qtquick-tool-qmlls.qdoc b/src/qml/doc/src/qtqml-tooling-qmlls.qdoc
index 5e6e62cd5a..f45b6162d6 100644
--- a/src/quick/doc/src/guidelines/qtquick-tool-qmlls.qdoc
+++ b/src/qml/doc/src/qtqml-tooling-qmlls.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
-\page qtquick-tool-qmlls.html
+\page qtqml-tooling-qmlls.html
\title QML Language Server
\brief Overview of the QML Language Server (qmlls).
\ingroup explanations-tools
diff --git a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
index ed1d84ac23..4833f494c0 100644
--- a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
+++ b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
@@ -75,7 +75,7 @@ tests are setup, UI tests are a lot easier to run.
\section1 qmllint
-\l{qtquick-tool-qmllint.html}{qmllint} is a tool shipped with Qt, that verifies
+\l{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.