diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2023-02-17 14:16:17 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2023-02-22 09:57:16 +0000 |
commit | 27760c38c64cc2def780d849dc372f5cc28dee33 (patch) | |
tree | 8bb1c21b49684ffa01aff39a1af5134814a7c197 /doc | |
parent | 035c67f7f535760c81d8ef26ad366f2d2ebe5c57 (diff) | |
download | qt-creator-27760c38c64cc2def780d849dc372f5cc28dee33.tar.gz |
Doc: Describe Call Hierarchy view and language server button
Task-number: QTCREATORBUG-28721
Change-Id: I9275c5f0a7ca838aab29c42962e88d4b80ed8622
Reviewed-by: David Schulz <david.schulz@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/qtcreator/images/icons/languageclient.png | bin | 0 -> 283 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qtcreator-call-hierarchy-view.png | bin | 0 -> 1773 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qtcreator-editortoolbar-symbols.png | bin | 24161 -> 0 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qtcreator-editortoolbar-symbols.webp | bin | 0 -> 10548 bytes | |||
-rw-r--r-- | doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc | 12 | ||||
-rw-r--r-- | doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc | 6 | ||||
-rw-r--r-- | doc/qtcreator/src/user-interface/creator-views.qdoc | 15 |
7 files changed, 32 insertions, 1 deletions
diff --git a/doc/qtcreator/images/icons/languageclient.png b/doc/qtcreator/images/icons/languageclient.png Binary files differnew file mode 100644 index 0000000000..878b4df4b9 --- /dev/null +++ b/doc/qtcreator/images/icons/languageclient.png diff --git a/doc/qtcreator/images/qtcreator-call-hierarchy-view.png b/doc/qtcreator/images/qtcreator-call-hierarchy-view.png Binary files differnew file mode 100644 index 0000000000..95f0c87dd3 --- /dev/null +++ b/doc/qtcreator/images/qtcreator-call-hierarchy-view.png diff --git a/doc/qtcreator/images/qtcreator-editortoolbar-symbols.png b/doc/qtcreator/images/qtcreator-editortoolbar-symbols.png Binary files differdeleted file mode 100644 index 8128c7ae13..0000000000 --- a/doc/qtcreator/images/qtcreator-editortoolbar-symbols.png +++ /dev/null diff --git a/doc/qtcreator/images/qtcreator-editortoolbar-symbols.webp b/doc/qtcreator/images/qtcreator-editortoolbar-symbols.webp Binary files differnew file mode 100644 index 0000000000..4c26207b89 --- /dev/null +++ b/doc/qtcreator/images/qtcreator-editortoolbar-symbols.webp diff --git a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc index 72d4595a08..82d3530d2b 100644 --- a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc @@ -28,7 +28,7 @@ open in the editor. \if defined(qtcreator) - \image qtcreator-editortoolbar-symbols.png + \image qtcreator-editortoolbar-symbols.webp {Edit mode toolbar} \else \image studio-edit-mode.png \endif @@ -116,6 +116,16 @@ \uicontrol {Project Settings} > \uicontrol Editor. \if defined(qtcreator) For more information, see \l {Specifying Editor Settings}. + + \section2 Managing Language Servers + + Select the \inlineimage icons/languageclient.png + icon on the editor toolbar (7) to view the \l{Using Language Servers} + {language server} for the current project. You can restart the language + server or select another one in the menu. Also, you can + \l{Inspecting Language Clients}{inspect the communication} between \QC + and language servers and view server capabilities, as well as + \l{Specifying Settings for Language Clients}{set language server preferences}. \endif \section1 Editing Selected Lines 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 831c92ec4e..99dcfb69ea 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc @@ -32,6 +32,8 @@ \l{Viewing Defined Types and Symbols}{Outline} view or in the \uicontrol Symbols list on the \l{Using the Editor Toolbar} {editor toolbar} + \li \l{Viewing Call Hierarchy} + {Viewing the callers and callees of a function} \li \l{Finding Symbols}{Finding references to symbols} \li \l{Renaming Symbols}{Renaming the symbol under cursor} \li Code actions @@ -184,6 +186,10 @@ determines when the server is started. The information displayed depends on the language server. + Select the \inlineimage icons/languageclient.png + button on the \l{Managing Language Servers}{editor toolbar}, and then select + \uicontrol {Restart} to restart language servers. + \uicontrol Log displays additional information about the selected log entry. You can see the \uicontrol {Content length} and \uicontrol {MIME type} of a \uicontrol {Client Message} and \uicontrol {Server Message}, as well as diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index 12faa3bb0d..856dfd15ee 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -102,6 +102,21 @@ To visit all parts of a namespace, double-click on the namespace item multiple times. + \section1 Viewing Call Hierarchy + + The \uicontrol {Call Hierarchy} view shows information about incoming and + outgoing function calls from a \l{Using Language Servers}{language server}. + Place the cursor on a function definition in the code editor to see lists + of functions that call it and the functions it calls. This works recursively, + so you can also see the caller of the caller. However, Clangd only lists + incoming calls. + + Select the \inlineimage icons/languageclient.png + button on the \l{Managing Language Servers}{editor toolbar}, and then select + \uicontrol {Restart} to collect call hierarchy information for the function. + + \image qtcreator-call-hierarchy-view.png {Call Hierarchy view} + \section1 Viewing Type Hierarchy To view the base classes and derived classes of a class, right-click the |