This is an archive of the discontinued LLVM Phabricator instance.

Differential D58717

Added documentation for clangd v9+ features
ClosedPublic

Authored by gribozavr on Feb 27 2019, 7:58 AM.

Details

Reviewers
ilya-biryukov
Commits
rG5d58625e0519: Added documentation for clangd v9+ features
rCTE354994: Added documentation for clangd v9+ features
rL354994: Added documentation for clangd v9+ features

Diff Detail

Repository
rL LLVM

Event Timeline

gribozavr created this revision.Feb 27 2019, 7:58 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 27 2019, 7:58 AM
Herald added subscribers: cfe-commits, jdoerfert, kadircet and 4 others. · View Herald Transcript
ilya-biryukov accepted this revision.Feb 27 2019, 7:59 AM

LGTM

This revision is now accepted and ready to land.Feb 27 2019, 7:59 AM
Harbormaster completed remote builds in B28592: Diff 188542.Feb 27 2019, 8:00 AM
Closed by commit rL354994: Added documentation for clangd v9+ features (authored by gribozavr). · Explain WhyFeb 27 2019, 8:10 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptFeb 27 2019, 8:10 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript

Revision Contents

PathSize
clang-tools-extra/
trunk/
docs/
clangd/
34 lines

Diff 188546

clang-tools-extra/trunk/docs/clangd/Features.rst

Show All 32 Lines
:raw-html:`<details><summary markdown="span">Animated demo</summary>` :raw-html:`<details><summary markdown="span">Animated demo</summary>`
.. image:: ApplyFixInVSCode.gif .. image:: ApplyFixInVSCode.gif
:align: center :align: center
:alt: Applying a fix suggested by the compiler :alt: Applying a fix suggested by the compiler
:raw-html:`</details>` :raw-html:`</details>`
**(New in v9)**
If a missing symbol was seen in a file you've edited recently, clangd will
suggest inserting it.
clang-tidy checks
-----------------
**(New in v9)**
clangd embeds `clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`__
which provides extra hints about code problems: bug-prone patterns,
performance traps, and style issues.
:raw-html:`<details><summary markdown="span">Animated demo</summary>`
.. image:: ApplyClangTidyFixInVSCode.gif
:align: center
:alt: Applying a fix suggested by the compiler
:raw-html:`</details>`
clangd respects your project's ``.clang-tidy`` file which controls the checks
to run. Not all checks work within clangd. You must pass the ``-clang-tidy``
flag to enable this feature.
Code completion Code completion
=============== ===============
You'll see suggestions as you type based on what methods, variables, etc are You'll see suggestions as you type based on what methods, variables, etc are
available in this context. available in this context.
:raw-html:`<details><summary markdown="span">Screenshot</summary>` :raw-html:`<details><summary markdown="span">Screenshot</summary>`
Show All 38 Lines
Cross-references Cross-references
================ ================
The following features let you navigate your codebase. The following features let you navigate your codebase.
If there is no project-wide index, cross-references work across the files If there is no project-wide index, cross-references work across the files
you have opened. you have opened.
**(New in v9)**
clangd will also automatically index your whole project.
Find definition/declaration Find definition/declaration
--------------------------- ---------------------------
Jump to the definition or declaration of a symbol under the cursor. Jump to the definition or declaration of a symbol under the cursor.
:raw-html:`<details><summary markdown="span">Animated demo</summary>` :raw-html:`<details><summary markdown="span">Animated demo</summary>`
.. image:: GoToDefinitionInVSCode.gif .. image:: GoToDefinitionInVSCode.gif
:align: center :align: center
:alt: Demonstration of the "Go to definition" feature :alt: Demonstration of the "Go to definition" feature
:raw-html:`</details>` :raw-html:`</details>`
**(New in v9)**
Some editors only expose "find definition"; use "find definition" on the
definition to jump to the declaration.
"Find definition" also works on ``#include`` lines, to jump to the included
file.
Find references Find references
--------------- ---------------
Show all references to a symbol under the cursor. Show all references to a symbol under the cursor.
:raw-html:`<details><summary markdown="span">Animated demo</summary>` :raw-html:`<details><summary markdown="span">Animated demo</summary>`
.. image:: FindAllReferencesInVSCode.gif .. image:: FindAllReferencesInVSCode.gif
▲ Show 20 Lines • Show All 116 Lines • Show Last 20 Lines