Doc: Update docs about configuring language servers

- The QMLLS preferences moved to Language Client
- The project-specific Qt Quick settings just link to the
  QMLLS settings

Task-number: QTCREATORBUG-32016
Change-Id: I0b121f23ed5f54d6be169b03864ae5d9046e6531
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Leena Miettinen
2025-01-14 14:39:12 +01:00
parent 72ab15753b
commit faf8ccdcf4
6 changed files with 40 additions and 54 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 9.9 KiB

View File

@@ -80,14 +80,11 @@
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}
\image qtcreator-preferences-language-client-qmlls.webp {Language Client General preferences}
To enable a language server, select the checkbox next to the language
server name and set server preferences.
To configure \l{Configure \QMLLS}{\QMLLS}, go to
\preferences > \uicontrol {Qt Quick} > \uicontrol {QML/JS Editing}.
To remove language servers from the list, select \uicontrol Delete.
\section1 Updating Python Language Server
@@ -240,15 +237,28 @@
Since Qt 6.4, \QMLLS offers code completion and issues warnings for QML.
To turn off \QMLLS, go to \preferences > \uicontrol {Qt Quick} >
\uicontrol {QML/JS Editing} and clear \uicontrol {Turn on}.
To set preferences for \QMLLS, go to \preferences >
\uicontrol {Language Client} > \uicontrol General and
select \uicontrol {\QMLLS}.
\image qtcreator-preferences-language-client-qmlls.webp {QML Language Server in Language Client preferences}
\section1 Turn off \QMLLS
To turn off \QMLLS, clear the \uicontrol {\QMLLS} checkbox.
\section1 Use advanced features
By default, \QMLLS issues warning messages and provides code completion,
while the embedded code model handles advanced features, such as renaming
symbols and finding usages. To disable the embedded code model and use
\QMLLS for everything, select \uicontrol {Use advanced features}.
symbols and finding usages.
Also, \QC tries to use \QMLLS shipped with the Qt version in your current
To disable the embedded code model and use \QMLLS for everything, select
\uicontrol {Use advanced features}.
\section1 Select \QMLLS version
\QC tries to use \QMLLS shipped with the Qt version in your current
\l{Kits}{kit}. To override that behavior and always use
\QMLLS of the highest registered Qt version, select
\uicontrol {Use from latest Qt version}.
@@ -256,7 +266,7 @@
To use older \QMLLS versions, select
\uicontrol{Allow versions below Qt 6.8}.
\image qtcreator-qml-js-editing.webp {QML/JS Editing preferences}
\section1 Automatically configure new CMake projects
To automatically configure new CMake projects, select
\uicontrol {Create .qmlls.ini files for new projects}.
@@ -330,7 +340,23 @@
\ingroup creator-how-to-lsp
\ingroup creator-how-to-projects-configure
\title Configure language server workspace
\title Configure language servers for projects
To configure language servers for the current project, go to
\uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol {Language Server}.
\image qtcreator-projects-settings-language-server.webp {Language Server settings for a project}
To add language servers and change their preferences, select
\uicontrol {Global settings}.
\section1 Turn on and off language servers
To turn on and off language servers, select \uicontrol Enabled or
\uicontrol Disabled in \uicontrol {Project Specific Language Servers}.
\section1 Configure language server workspace
The language client sends the contents of the
\uicontrol {Workspace Configuration} field as a JSON file to all language
@@ -338,18 +364,8 @@
JSON file must be valid JSON. The available settings depend on the language
server.
To configure the language server workspace for the current project:
\list 1
\li Go to \uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol {Language Server}.
\image qtcreator-projects-settings-language-server.webp {Language Server settings for a project}
\li In \uicontrol {Workspace Configuration}, specify language server
settings using valid JSON format.
\endlist
To add language servers and change their preferences, go to
\uicontrol {Global settings}.
In \uicontrol {Workspace Configuration}, specify language server settings
using valid JSON format.
\sa {Manage Language Servers}{How To: Manage Language Servers},
{Language Servers}, {Configuring Projects}

View File

@@ -93,8 +93,7 @@
\li \l{Specify editor settings}{Editor}
\li \l{Specify the environment for projects}{Environment}
\li \l{Link projects with GitLab}{GitLab}
\li \l{Configure language server workspace}{Language Server}
\li \l{Turn on or off \QMLLS for a project}{Qt Quick}
\li \l{Configure language servers for projects}{Language Server}
\li \l{Specify settings for quick fixes}{Quick Fixes}
\li \l{Apply filters before scanning for tests}{Testing}
\li \l{Exclude files from to-do lists}{To-Do} (experimental)

View File

@@ -1,29 +0,0 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-qt-quick-settings-for-projects.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects-configure
\ingroup creator-how-to-lsp
\title Turn on or off \QMLLS for a project
Since Qt 6.4, \QMLLS offers code completion and issues warnings for QML.
To turn on or off \QMLLS for the current project:
\list 1
\li Select \uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol {Qt Quick}.
\image qtcreator-projects-settings-qt-quick.webp {Qt Quick settings for a project}
\li Clear \uicontrol {Use global settings}.
\li Clear or select \uicontrol {Turn on}.
\endlist
To view and modify the global settings, select the link in
\uicontrol {Use global settings}.
\sa {Configure \QMLLS}, {Configuring Projects}
*/