diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2021-03-25 13:32:57 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2021-03-26 07:53:07 +0000 |
commit | 9d0c3dc3d677956e0dbbfb1083d6ef22f4fa205f (patch) | |
tree | a1c25932d0ef6d945b55d9a335559016e4d9107b | |
parent | 23f6aea6d3ad405286aa4f5b5a492409d0860af4 (diff) |
Doc: Describe new Language Client options
Fixes: QTCREATORBUG-25530
Change-Id: Ia59e476cdd6a1d655f269293c8e6ef97c5b084b5
Reviewed-by: David Schulz <david.schulz@qt.io>
-rw-r--r-- | doc/qtcreator/images/qtcreator-language-client-options-java.png | bin | 0 -> 7749 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qtcreator-language-client-options.png | bin | 10819 -> 10533 bytes | |||
-rw-r--r-- | doc/qtcreator/src/android/androiddev.qdoc | 6 | ||||
-rw-r--r-- | doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc | 61 |
4 files changed, 51 insertions, 16 deletions
diff --git a/doc/qtcreator/images/qtcreator-language-client-options-java.png b/doc/qtcreator/images/qtcreator-language-client-options-java.png Binary files differnew file mode 100644 index 0000000000..d70df4dd47 --- /dev/null +++ b/doc/qtcreator/images/qtcreator-language-client-options-java.png diff --git a/doc/qtcreator/images/qtcreator-language-client-options.png b/doc/qtcreator/images/qtcreator-language-client-options.png Binary files differindex ab1a0e09d3..0ae18ec4e4 100644 --- a/doc/qtcreator/images/qtcreator-language-client-options.png +++ b/doc/qtcreator/images/qtcreator-language-client-options.png diff --git a/doc/qtcreator/src/android/androiddev.qdoc b/doc/qtcreator/src/android/androiddev.qdoc index 2aa36b9f83..ed53310649 100644 --- a/doc/qtcreator/src/android/androiddev.qdoc +++ b/doc/qtcreator/src/android/androiddev.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** 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 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 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 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 3faa85d43a..1d668a3e07 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -78,17 +78,33 @@ \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 \li Select \uicontrol Tools > \uicontrol Options > - \uicontrol {Language Client} (or \uicontrol {Qt Creator} > - \uicontrol Preferences > \uicontrol {Language Client} > on - \macos) to view a list of language servers. - \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. + \uicontrol {Language Client} > \uicontrol Add > + \uicontrol {New Generic StdIO Language Server} + to add a generic language server. \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 @@ -102,9 +118,8 @@ with a matching MIME type is opened. The \uicontrol {General Messages} \l{Viewing Output}{output pane} displays information about the connection to the language server. - \li In the \uicontrol Capabilities field, you can see the features - that are supported by the language server. Only some of them are - implemented by \QC. + \li In the \uicontrol Initialization field, you can add language server + specific JSON attributes to pass to an \c initialize request. \li In the \uicontrol Executable field, enter the path to the language server executable. \li In the \uicontrol Arguments field, enter any required command line @@ -112,7 +127,23 @@ arguments. \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 @@ -129,8 +160,8 @@ \section1 Reporting Issues - The language service client has been mostly tested with Python. - If problems arise when you try it or some other language, please select + The language service client has been mostly tested with Python and Java. + If problems arise when you try them or some other language, please select \uicontrol Help > \uicontrol {Report Bug} to report them in the \l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports should include \QC console output with the environment |