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 <david.schulz@qt.io>
This commit is contained in:
Leena Miettinen
2019-03-15 11:05:13 +01:00
parent 3a71aaef96
commit d7e3954f24
4 changed files with 23 additions and 10 deletions

View File

@@ -20,7 +20,8 @@ Editing
* Language Client * Language Client
* Added support for document outline (QTCREATORBUG-21573) * 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 * Added support for code actions
* Highlighter * Highlighter
* Replaced custom highlighting file parser with `KSyntaxHighlighting` * Replaced custom highlighting file parser with `KSyntaxHighlighting`

View File

@@ -52,7 +52,8 @@
{following symbols}, and so on {following symbols}, and so on
\li Inspecting code by using the \l{Browsing Project Contents} \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 \li Diagnostics

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2019 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.
@@ -34,9 +34,19 @@
For several programming languages, a \e {language server} is available For several programming languages, a \e {language server} is available
that provides information about the code to IDEs as long as they support that provides information about the code to IDEs as long as they support
communication via the language server protocol (LSP). This enables the communication via the language server protocol (LSP). This enables the
IDE to provide code completion, highlighting of the symbol under cursor, IDE to provide the following services:
and jumping to the symbol definition, as well as to integrate diagnostics
from the language server. \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 By providing a client for the language server protocol, \QC can support
the above features for several other programming languages besides C++. the above features for several other programming languages besides C++.

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2019 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.
@@ -268,14 +268,15 @@
//! [outline view] //! [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 \list
\li To see a complete list of all bindings, select \li To see a complete list of all bindings, select
\uicontrol {Filter Tree} > \uicontrol {Show All Bindings}. \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}. editor, deselect \uicontrol {Synchronize with Editor}.
\endlist \endlist