diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-05-17 09:42:24 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-05-17 09:07:23 +0000 |
commit | c7803fe6ae8234f9e23ec1bc00481e7d76e8ac38 (patch) | |
tree | 5dbb76e5e5599e7f80b687edbaaeda2962921802 | |
parent | 2b23a359d4de4a7572a3af089c928b56b67a35d0 (diff) |
Doc: Mention QML Language Server in "Adding Language Servers"
- Add a link to "Turn on QML Language Server".
- Add the \QMLLS macro and use it everywhere.
Fixes: QTCREATORBUG-30823
Change-Id: I75ff67967ad6bf592dceeae46486713012aafd50
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
-rw-r--r-- | doc/config/macros.qdocconf | 1 | ||||
-rw-r--r-- | doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc | 35 |
2 files changed, 21 insertions, 15 deletions
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index f881062d13..5117f9f3e4 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -32,6 +32,7 @@ macro.QDV = "Qt Design Viewer" macro.QL = "Qt Linguist" macro.QMCU = "Qt for MCUs" macro.QMLD = "Qt Quick Designer" +macro.QMLLS = "QML Language Server" macro.QQV = "Qt QML Viewer" macro.QSDK = "Qt" macro.QUL = "Qt Quick Ultralite" diff --git a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc index 8c01b9cfef..aff9f9f357 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc @@ -62,7 +62,8 @@ \section1 Adding Language Servers - \QC adds a Python language server by default. + \QC adds a \l{Configure Python language servers}{Python language server} by + default. Also, it offers to install language servers for JSON and YAML files when you open them in the editor if it can find the @@ -71,18 +72,22 @@ \image qtcreator-language-server-json.webp {Prompt to install JSON language server} - Add a Java language server for \l{Connecting Android Devices} - {Android development}. For other languages, add generic stdIO language - servers. + \l{Add a Java language server} for \l{Connecting Android Devices} + {Android development}. For other languages, + \l{Add generic language servers}{add generic stdIO language servers}. To add language servers, go to \preferences > \uicontrol {Language Client} and select \uicontrol Add. \image qtcreator-language-client-options-java.png {Java language server preferences} - To enable a language server, select the check box next to the language + To enable a language server, select the checkbox next to the language server name and set server preferences. + To turn on \l{Turn on \QMLLS}{\QMLLS}, go to + \preferences > \uicontrol {Qt Quick} > \uicontrol {QML/JS Editing} and + select \uicontrol {Enable \QMLLS}. + To remove language servers from the list, select \uicontrol Delete. \section1 Supported Locator Filters @@ -218,23 +223,23 @@ \ingroup creator-how-to-lsp - \title Turn on QML Language Server + \title Turn on \QMLLS - Since Qt 6.4, the QML language server offers code completion and + Since Qt 6.4, \QMLLS offers code completion and issues warnings for QML. To use it, go to \preferences > \uicontrol {Qt Quick} > \uicontrol {QML/JS Editing} and select - \uicontrol {Enable QML Language Server}. + \uicontrol {Enable \QMLLS}. - By default, enabling the QML language server will only enable warning messages + By default, enabling \QMLLS will only enable warning messages and code completion, while advanced features such as renaming and finding usages will be handled by the embedded code model. - To disable the embedded code model and use the QML language server for everything, - select \uicontrol {Use QML Language Server advanced features}. + To disable the embedded code model and use \QMLLS for everything, + select \uicontrol {Use \QMLLS advanced features}. - Also, \QC tries to use the QML language server shipped with - the Qt version in your current kit. To override that behavior and always use the - QML language server of the highest registered Qt version, select - \uicontrol {Use QML Language Server from latest Qt version}. + Also, \QC tries to use \QMLLS shipped with + the Qt version in your current kit. To override that behavior and always use + \QMLLS of the highest registered Qt version, select + \uicontrol {Use \QMLLS from latest Qt version}. \image qtcreator-qml-js-editing.webp {QML/JS Editing preferences} |