From d7e3954f242b8656310da86fb6e59c47ab036ca6 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 15 Mar 2019 11:05:13 +0100 Subject: [PATCH] Doc: List services provided by the language server Add links to more information about the services. Rewrite the section about the Outline sidebar view to better match other languages beside QML. Change-Id: If9bc710c034c938fc49d67252f14fc3237feedcb Reviewed-by: David Schulz --- dist/changes-4.9.0.md | 3 ++- .../creator-only/creator-clang-codemodel.qdoc | 3 ++- .../creator-only/creator-language-server.qdoc | 18 ++++++++++++++---- doc/src/howto/creator-sidebar-views.qdocinc | 9 +++++---- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/dist/changes-4.9.0.md b/dist/changes-4.9.0.md index 8feed6ec314..a5db399027b 100644 --- a/dist/changes-4.9.0.md +++ b/dist/changes-4.9.0.md @@ -20,7 +20,8 @@ Editing * Language Client * Added support for document outline (QTCREATORBUG-21573) - * Added support for `Find Usages` (QTCREATORBUG-21577) + * Added support for `Find References to Symbol Under Cursor` + (QTCREATORBUG-21577) * Added support for code actions * Highlighter * Replaced custom highlighting file parser with `KSyntaxHighlighting` diff --git a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc index 7fd7791209b..f8e2b890c15 100644 --- a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc +++ b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc @@ -52,7 +52,8 @@ {following symbols}, and so on \li Inspecting code by using the \l{Browsing Project Contents} - {class browser}, the \l{Viewing QML Types}{outline}, and so on + {class browser}, the \l{Viewing Defined Types and Symbols} + {outline}, and so on \li Diagnostics diff --git a/doc/src/editors/creator-only/creator-language-server.qdoc b/doc/src/editors/creator-only/creator-language-server.qdoc index 7bf030f1b0f..4b75aae16e1 100644 --- a/doc/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/src/editors/creator-only/creator-language-server.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -34,9 +34,19 @@ For several programming languages, a \e {language server} is available that provides information about the code to IDEs as long as they support communication via the language server protocol (LSP). This enables the - IDE to provide code completion, highlighting of the symbol under cursor, - and jumping to the symbol definition, as well as to integrate diagnostics - from the language server. + IDE to provide the following services: + + \list + \li \l{Completing Code}{Code completion} + \li Highlighting the symbol under cursor + \li \l{Moving to Symbol Definition or Declaration} + {Moving to the symbol definition} + \li Inspecting code by viewing the document + \l{Viewing Defined Types and Symbols}{outline} + \li \l{Finding Symbols}{Finding references to symbols} + \li Code actions + \li Integrating diagnostics from the language server + \endlist By providing a client for the language server protocol, \QC can support the above features for several other programming languages besides C++. diff --git a/doc/src/howto/creator-sidebar-views.qdocinc b/doc/src/howto/creator-sidebar-views.qdocinc index 5269e5f0ee2..bb4daaa72b0 100644 --- a/doc/src/howto/creator-sidebar-views.qdocinc +++ b/doc/src/howto/creator-sidebar-views.qdocinc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -268,14 +268,15 @@ //! [outline view] - \section2 Viewing QML Types + \section2 Viewing Defined Types and Symbols - The \uicontrol Outline view shows the type hierarchy in a QML file. + The \uicontrol Outline view shows an overview of defined types and other + symbols, as well as their properties and hierarchy in a source file. \list \li To see a complete list of all bindings, select \uicontrol {Filter Tree} > \uicontrol {Show All Bindings}. - \li To stop the synchronization with the QML type selected in the + \li To stop the synchronization with the type or symbol selected in the editor, deselect \uicontrol {Synchronize with Editor}. \endlist