forked from qt-creator/qt-creator
Doc: Describe new Language Client options
Fixes: QTCREATORBUG-25530 Change-Id: Ia59e476cdd6a1d655f269293c8e6ef97c5b084b5 Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
BIN
doc/qtcreator/images/qtcreator-language-client-options-java.png
Normal file
BIN
doc/qtcreator/images/qtcreator-language-client-options-java.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 10 KiB |
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2020 The Qt Company Ltd.
|
** Copyright (C) 2021 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Creator documentation.
|
** This file is part of the Qt Creator documentation.
|
||||||
@@ -51,6 +51,10 @@
|
|||||||
for such a Qt version, the minimum required Android version on devices
|
for such a Qt version, the minimum required Android version on devices
|
||||||
is 5.0 (API level 21). For more information, see \l{Qt for Android}.
|
is 5.0 (API level 21). For more information, see \l{Qt for Android}.
|
||||||
|
|
||||||
|
To enable helpful code editing features for Java, such as code completion,
|
||||||
|
highlighting, function tooltips, and navigating in code, specify settings
|
||||||
|
for a \l{Specifying Java Language Server Settings}{Java language server}.
|
||||||
|
|
||||||
The Android Debug Bridge (adb) command line tool is integrated to \QC to
|
The Android Debug Bridge (adb) command line tool is integrated to \QC to
|
||||||
enable you to deploy applications to connected Android devices, to run
|
enable you to deploy applications to connected Android devices, to run
|
||||||
them, and to read their logs. It includes a client and server that run on
|
them, and to read their logs. It includes a client and server that run on
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2020 The Qt Company Ltd.
|
** Copyright (C) 2021 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Creator documentation.
|
** This file is part of the Qt Creator documentation.
|
||||||
@@ -78,17 +78,33 @@
|
|||||||
|
|
||||||
\section1 Specifying Settings for Language Clients
|
\section1 Specifying Settings for Language Clients
|
||||||
|
|
||||||
To use a language server:
|
You can add a generic generic stdIO language server for Python, for example.
|
||||||
|
For \l{Connecting Android Devices}{Android development}, you can add a Java
|
||||||
|
language server.
|
||||||
|
|
||||||
|
\section2 Adding Language Servers
|
||||||
|
|
||||||
|
To view a list of language servers, select \uicontrol Tools >
|
||||||
|
\uicontrol Options > \uicontrol {Language Client} (or
|
||||||
|
\uicontrol {Qt Creator} > \uicontrol Preferences >
|
||||||
|
\uicontrol {Language Client} > on \macos).
|
||||||
|
|
||||||
|
\image qtcreator-language-client-options.png "Language client options page"
|
||||||
|
|
||||||
|
To enable a language server, select the check box next to the language
|
||||||
|
server name and specify settings for the server.
|
||||||
|
|
||||||
|
To remove language servers from the list, select \uicontrol Delete.
|
||||||
|
|
||||||
|
\section2 Specifying Generic Settings
|
||||||
|
|
||||||
|
To add a generic language server:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
\li Select \uicontrol Tools > \uicontrol Options >
|
\li Select \uicontrol Tools > \uicontrol Options >
|
||||||
\uicontrol {Language Client} (or \uicontrol {Qt Creator} >
|
\uicontrol {Language Client} > \uicontrol Add >
|
||||||
\uicontrol Preferences > \uicontrol {Language Client} > on
|
\uicontrol {New Generic StdIO Language Server}
|
||||||
\macos) to view a list of language servers.
|
to add a generic language server.
|
||||||
\image qtcreator-language-client-options.png "Language client options page"
|
|
||||||
\li Select the check box next to the language server name to enable the
|
|
||||||
language server.
|
|
||||||
\li Select \uicontrol Add to add language servers.
|
|
||||||
\li In the \uicontrol Name field, enter a name for the language server.
|
\li In the \uicontrol Name field, enter a name for the language server.
|
||||||
Select the \inlineimage replace.png
|
Select the \inlineimage replace.png
|
||||||
(\uicontrol {Variables}) button to use a variable for the server
|
(\uicontrol {Variables}) button to use a variable for the server
|
||||||
@@ -102,9 +118,8 @@
|
|||||||
with a matching MIME type is opened. The
|
with a matching MIME type is opened. The
|
||||||
\uicontrol {General Messages} \l{Viewing Output}{output pane}
|
\uicontrol {General Messages} \l{Viewing Output}{output pane}
|
||||||
displays information about the connection to the language server.
|
displays information about the connection to the language server.
|
||||||
\li In the \uicontrol Capabilities field, you can see the features
|
\li In the \uicontrol Initialization field, you can add language server
|
||||||
that are supported by the language server. Only some of them are
|
specific JSON attributes to pass to an \c initialize request.
|
||||||
implemented by \QC.
|
|
||||||
\li In the \uicontrol Executable field, enter the path to the language
|
\li In the \uicontrol Executable field, enter the path to the language
|
||||||
server executable.
|
server executable.
|
||||||
\li In the \uicontrol Arguments field, enter any required command line
|
\li In the \uicontrol Arguments field, enter any required command line
|
||||||
@@ -112,7 +127,23 @@
|
|||||||
arguments.
|
arguments.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To remove language servers from the list, select \uicontrol Delete.
|
\section2 Specifying Java Language Server Settings
|
||||||
|
|
||||||
|
To add a Java language server:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
\li Select \uicontrol Tools > \uicontrol Options >
|
||||||
|
\uicontrol {Language Client} > \uicontrol Add >
|
||||||
|
\uicontrol {New Java Language Server} to add a Java language server.
|
||||||
|
\image qtcreator-language-client-options-java.png "Java language server options"
|
||||||
|
\li In the \uicontrol Name field, enter a name for the language server.
|
||||||
|
Select the \inlineimage replace.png
|
||||||
|
(\uicontrol {Variables}) button to use a variable for the server
|
||||||
|
name. For more information, see \l{Using Qt Creator Variables}.
|
||||||
|
\li In the \uicontrol Java field, enter the path to the Java executable.
|
||||||
|
\li In the \uicontrol {Java Language Server} field, enter the path to
|
||||||
|
the Java language server \c .jar file.
|
||||||
|
\endlist
|
||||||
|
|
||||||
\section1 Supported Locator Filters
|
\section1 Supported Locator Filters
|
||||||
|
|
||||||
@@ -129,8 +160,8 @@
|
|||||||
|
|
||||||
\section1 Reporting Issues
|
\section1 Reporting Issues
|
||||||
|
|
||||||
The language service client has been mostly tested with Python.
|
The language service client has been mostly tested with Python and Java.
|
||||||
If problems arise when you try it or some other language, please select
|
If problems arise when you try them or some other language, please select
|
||||||
\uicontrol Help > \uicontrol {Report Bug} to report them in the
|
\uicontrol Help > \uicontrol {Report Bug} to report them in the
|
||||||
\l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports
|
\l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports
|
||||||
should include \QC console output with the environment
|
should include \QC console output with the environment
|
||||||
|
|||||||
Reference in New Issue
Block a user