summaryrefslogtreecommitdiffstats
path: root/docs/clangd/index.rst
blob: 46939062876f1e2f50bfe3f6657a94922533e296 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
======
clangd
======

.. toctree::
   :maxdepth: 1

   Installation
   Features

What is clangd?
===============

clangd understands your C++ code and adds smart features to your editor: code
completion, compile errors, go-to-definition and more.

clangd is a language server that implements the `Language Server Protocol
<https://github.com/Microsoft/language-server-protocol>`__; it can work with
many editors through a plugin.  Here's Visual Studio Code with the clangd
plugin, demonstrating code completion:

.. image:: CodeCompletionInVSCode.png
   :align: center
   :alt: Code completion in VSCode

clangd is based on the `Clang <https://clang.llvm.org>`__ C++ compiler, and is
part of the `LLVM <https://llvm.org>`__ project.