aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src
diff options
context:
space:
mode:
authorSami Shalayel <sami.shalayel@qt.io>2024-01-16 17:11:14 +0100
committerSami Shalayel <sami.shalayel@qt.io>2024-02-27 10:54:32 +0100
commit247003ddbc985b1fe93484243178434a1354b8da (patch)
tree43fb928f92a35d6803747edca8ec05cfbe7b7867 /src/qml/doc/src
parent9dd8454f04778ce10a6ff91d1c22788443dc3e8c (diff)
doc: change names of qmllint and qmlls pages
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>
Diffstat (limited to 'src/qml/doc/src')
-rw-r--r--src/qml/doc/src/cmake/cmake-variables.qdoc4
-rw-r--r--src/qml/doc/src/cppintegration/contextproperties.qdoc7
-rw-r--r--src/qml/doc/src/javascript/hostenvironment.qdoc2
-rw-r--r--src/qml/doc/src/qmllanguageref/documents/structure.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/import.qdoc9
-rw-r--r--src/qml/doc/src/qmllint/missing-type.qdoc5
-rw-r--r--src/qml/doc/src/qmllint/signal-handler-parameters.qdoc3
-rw-r--r--src/qml/doc/src/qmlsingletons.qdoc2
-rw-r--r--src/qml/doc/src/qtqml-tooling.qdoc4
-rw-r--r--src/qml/doc/src/qtqml-writing-a-module.qdoc2
-rw-r--r--src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc2
-rw-r--r--src/qml/doc/src/tools/qtqml-tooling-qmlls.qdoc4
-rw-r--r--src/qml/doc/src/tools/qtquickcompiler/qtqml-qml-type-compiler.qdoc2
13 files changed, 26 insertions, 22 deletions
diff --git a/src/qml/doc/src/cmake/cmake-variables.qdoc b/src/qml/doc/src/cmake/cmake-variables.qdoc
index 4a7d1ff2f6..fac6916a0e 100644
--- a/src/qml/doc/src/cmake/cmake-variables.qdoc
+++ b/src/qml/doc/src/cmake/cmake-variables.qdoc
@@ -54,8 +54,8 @@ If \c{.qmlls.ini} files already exist there, then they are overwritten.
\note Using \c QT_QML_GENERATE_QMLLS_INI requires a CMake version >= 3.19.
These \c{.qmlls.ini} files contain the path to the last configured build directory,
-and is needed by \l{QML Language Server} to find user defined modules. See also
-\l{QML Language Server} about the other ways of passing build folder to QML Language Server.
+and is needed by \l{\QMLLS Reference}{\QMLLS} to find user defined modules. See also
+\l{\QMLLS Reference}{\QMLLS} about the other ways of passing build folders to \QMLLS.
As this variable is used for IDE integration, it should normally not be set in a project itself, but
diff --git a/src/qml/doc/src/cppintegration/contextproperties.qdoc b/src/qml/doc/src/cppintegration/contextproperties.qdoc
index 1133f0dce0..1783c0cdc8 100644
--- a/src/qml/doc/src/cppintegration/contextproperties.qdoc
+++ b/src/qml/doc/src/cppintegration/contextproperties.qdoc
@@ -13,9 +13,10 @@
finding out whether the place of re-use has a context sufficient for your code.
\warning Context properties are invisible to any tooling that processes QML code ahead of time,
- before you load it into the QML engine. The \l{Qt Quick Compiler}, \l{qmllint}, and the
- \l{QML Language Server} do not know anything about your context properties and will
- consider any access to context properties as an \e{unqualified access}.
+ before you load it into the QML engine. The \l{Qt Quick Compiler},
+ \l{qmllint Reference}{qmllint}, and the \l{\QMLLS Reference}{\QMLLS} do
+ not know anything about your context properties and will consider any access to context
+ properties as an \e{unqualified access}.
\note Context properties can generally be replaced either by regular properties on the root object
of a component, or by singletons defined either in C++ using \l{QML_SINGLETON}{QML_SINGLETON}
diff --git a/src/qml/doc/src/javascript/hostenvironment.qdoc b/src/qml/doc/src/javascript/hostenvironment.qdoc
index ec5217ff31..a27fe48fbe 100644
--- a/src/qml/doc/src/javascript/hostenvironment.qdoc
+++ b/src/qml/doc/src/javascript/hostenvironment.qdoc
@@ -41,7 +41,7 @@ takes an \c int and a \c string parameter, and returns a \c QtObject:
function doThings(a: int, b: string) : QtObject { ... }
\endqml
-Type annotations help tools like \l{Qt Creator} and \l{qmllint} to make sense
+Type annotations help tools like \l{Qt Creator} and \l{qmllint Reference}{qmllint} to make sense
of the code and provide better diagnostics. Moreover, they make functions easier
to use from C++. See
\l {qtqml-cppintegration-interactqmlfromcpp.html}{Interacting with QML Objects from C++}
diff --git a/src/qml/doc/src/qmllanguageref/documents/structure.qdoc b/src/qml/doc/src/qmllanguageref/documents/structure.qdoc
index c2453e1cb5..5a43ae2028 100644
--- a/src/qml/doc/src/qmllanguageref/documents/structure.qdoc
+++ b/src/qml/doc/src/qmllanguageref/documents/structure.qdoc
@@ -226,7 +226,7 @@ properties called \c{rect}.
Explicitly casting to the desired type helps tooling. It can allow the
\l{Qt Quick Compiler} generate efficient code where it otherwise would not be
-able to. You can use \l{qmllint} to find such occurrences.
+able to. You can use \l{qmllint Reference}{qmllint} to find such occurrences.
There is also a \c{Inaddressable} value you can use to explicitly specify the
default behavior.
diff --git a/src/qml/doc/src/qmllint/import.qdoc b/src/qml/doc/src/qmllint/import.qdoc
index 24e4f749bd..17f51d8544 100644
--- a/src/qml/doc/src/qmllint/import.qdoc
+++ b/src/qml/doc/src/qmllint/import.qdoc
@@ -51,14 +51,15 @@ Item {
\section3 User-Defined Module That Was Not Built
-Some tooling like \l{QML Language Server} or \l{qmllint} can't find user-defined modules when they
+Some tooling like \l{\QMLLS Reference}{\QMLLS} or \l{qmllint Reference}{qmllint}
+can't find user-defined modules when they
are not built. If your project defines the QML Module you are trying to import, then
the QML tooling will not find it until you build it.
-\note If building the module does not help when using \l{QML Language Server}, follow the
+\note If building the module does not help when using \l{\QMLLS Reference}{\QMLLS}, follow the
instructions in
-\l{QML Language Server#setting-up-the-qml-language-server-in-your-editor}{QML Language Server setup instructions}
-and make sure that you communicate the correct build folder to \l{QML Language Server}.
+\l{Setting up the QML Language Server in Your Editor}{\QMLLS setup instructions}
+and make sure that you communicate the correct build folder to \QMLLS.
\section3 Wrong Import Path
diff --git a/src/qml/doc/src/qmllint/missing-type.qdoc b/src/qml/doc/src/qmllint/missing-type.qdoc
index 7c19ec1820..466370ef39 100644
--- a/src/qml/doc/src/qmllint/missing-type.qdoc
+++ b/src/qml/doc/src/qmllint/missing-type.qdoc
@@ -32,7 +32,8 @@ a QML counterpart. The referenced property type might be missing the
\section2 Why is this bad?
QML tooling is not able to find the QML counterpart of the C++ type: the
\l{Qt Quick Compiler}{compiler} can't compile this property alias to
-C++ and \l{qmllint} as well as \l{QML Language Server} can't analyze this property alias.
+C++ and \l{qmllint Reference}{qmllint} as well as \l{\QMLLS Reference}{\QMLLS}
+can't analyze this property alias.
\section2 Example
Let our QML module have one C++ class with a property \c{myProperty}:
@@ -140,7 +141,7 @@ a QML counterpart. The property type might be missing the
\section2 Why is this bad?
QML tooling is not able to find the QML counterpart of the C++ type: the
\l{Qt Quick Compiler}{compiler} can't compile this property binding to
-C++ and \l{qmllint} as well as \l{QML Language Server} can't analyze this property binding.
+C++ and \l{qmllint Reference}{qmllint} as well as \l{\QMLLS Reference}{\QMLLS} can't analyze this property binding.
\section2 Example
Let our QML module have a C++ class with two properties, \c{myProperty} and \c{myProperty2}:
diff --git a/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc b/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
index 5de35a0b88..a6510b566b 100644
--- a/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
+++ b/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
@@ -42,7 +42,8 @@ hidden dependencies.
In both cases, QML tooling is not able to find the QML counterpart of the
C++ type: the \l{Qt Quick Compiler}{compiler} can't compile this signal handler to
-C++ and \l{qmllint} as well as \l{QML Language Server} can't analyze this handler.
+C++ and \l{qmllint Reference}{qmllint} as well as \l{\QMLLS Reference}{\QMLLS}
+can't analyze this handler.
\section2 Example
diff --git a/src/qml/doc/src/qmlsingletons.qdoc b/src/qml/doc/src/qmlsingletons.qdoc
index f89c7dea7a..ad441eca85 100644
--- a/src/qml/doc/src/qmlsingletons.qdoc
+++ b/src/qml/doc/src/qmlsingletons.qdoc
@@ -244,7 +244,7 @@ to the engine. That can be globally shared settings, like the spacing between
elements, or data models which need to be displayed in multiple places.
Compared to context properties which can solve a similar use case,
they have the benefit of being typed, being supported by tooling like the
-\l{QML Language Server}, and they are also generally faster at runtime.
+\l{\QMLLS Reference}{\QMLLS}, and they are also generally faster at runtime.
It is recommended not to register too many singletons in a module: Singletons,
once created, stay alive until the engine itself gets destroyed
diff --git a/src/qml/doc/src/qtqml-tooling.qdoc b/src/qml/doc/src/qtqml-tooling.qdoc
index 08097a66c3..45e4528a6b 100644
--- a/src/qml/doc/src/qtqml-tooling.qdoc
+++ b/src/qml/doc/src/qtqml-tooling.qdoc
@@ -16,9 +16,9 @@ A set of tools provided by the Qt Qml module that aim to facilitate a QML develo
during various phases of development. These tools are:
\list
- \li \l {qmllint}
+ \li \l {qmllint Reference}{qmllint}
\li \l {qmlformat}
- \li \l {QML Language Server}{qmlls}
+ \li \l {\QMLLS Reference}{qmlls}
\li \l {qmlprofiler}
\endlist
diff --git a/src/qml/doc/src/qtqml-writing-a-module.qdoc b/src/qml/doc/src/qtqml-writing-a-module.qdoc
index febd252359..c8a99f1a37 100644
--- a/src/qml/doc/src/qtqml-writing-a-module.qdoc
+++ b/src/qml/doc/src/qtqml-writing-a-module.qdoc
@@ -145,7 +145,7 @@ Item {
}
\endqml
-The solution here is to avoid the unqualified access. \l{qmllint} can be used to
+The solution here is to avoid the unqualified access. \l{qmllint Reference}{qmllint} can be used to
find such problems. The following example accesses the property you actually mean
in a safe, qualified way:
diff --git a/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc b/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc
index 8627badd2d..b26fe1eff0 100644
--- a/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc
+++ b/src/qml/doc/src/tools/qtqml-tooling-qmllint.qdoc
@@ -3,7 +3,7 @@
/*!
\page qtqml-tooling-qmllint.html
-\title qmllint
+\title qmllint Reference
\ingroup qtqml-tooling
\brief A tool for verifying the syntax of QML files and warning about
anti-patterns.
diff --git a/src/qml/doc/src/tools/qtqml-tooling-qmlls.qdoc b/src/qml/doc/src/tools/qtqml-tooling-qmlls.qdoc
index 5d24b186b5..50c8cac8e2 100644
--- a/src/qml/doc/src/tools/qtqml-tooling-qmlls.qdoc
+++ b/src/qml/doc/src/tools/qtqml-tooling-qmlls.qdoc
@@ -3,7 +3,7 @@
/*!
\page qtqml-tooling-qmlls.html
-\title QML Language Server
+\title \QMLLS Reference
\brief Overview of the QML Language Server (qmlls).
\ingroup qtqml-tooling
@@ -31,7 +31,7 @@ more details.
QML Language Server can automatically lint opened QML files
and display warnings or errors straight in the editor. See
-\l{qmllint} for more information about the linting process.
+\l{qmllint Reference}{qmllint} for more information about the linting process.
\section2 Formatting
diff --git a/src/qml/doc/src/tools/qtquickcompiler/qtqml-qml-type-compiler.qdoc b/src/qml/doc/src/tools/qtquickcompiler/qtqml-qml-type-compiler.qdoc
index a652900c85..b512be1b7e 100644
--- a/src/qml/doc/src/tools/qtquickcompiler/qtqml-qml-type-compiler.qdoc
+++ b/src/qml/doc/src/tools/qtquickcompiler/qtqml-qml-type-compiler.qdoc
@@ -46,7 +46,7 @@ arbitrary QML program (see \l{Known Limitations} for more details). When qmltc
fails, nothing is generated as your application cannot sensibly use the qmltc
output. If your program contains errors (or unsolvable warnings), they should be
fixed to enable the compilation. The general rule is to adhere to the best
-practices and follow \l{qmllint} advice.
+practices and follow \l{qmllint Reference}{qmllint} advice.
\note \c qmltc does not guarantee that the generated C++ stays API-, source- or
binary-compatible between past or future versions, even patch versions.