xref: /llvm-project/clang-tools-extra/docs/index.rst (revision 40c45b6b43180221acb49f387e7d3158adf49e3e)
1.. title:: Welcome to Extra Clang Tools's documentation!
2
3Introduction
4============
5Welcome to the clang-tools-extra project which contains extra tools built using
6Clang's tooling APIs.
7
8.. toctree::
9   :maxdepth: 1
10
11   ReleaseNotes
12
13Contents
14========
15.. toctree::
16   :maxdepth: 2
17
18   clang-tidy/index
19   clang-include-fixer
20   modularize
21   pp-trace
22   clangd <https://clangd.llvm.org/>
23   clang-doc
24
25
26Doxygen Documentation
27=====================
28The Doxygen documentation describes the **internal** software that makes up the
29tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
30documentation contains no instructions about how to use the tools, only the APIs
31that make up the software. For usage instructions, please see the user's guide
32or reference manual for each tool.
33
34* `Doxygen documentation`_
35
36.. _`Doxygen documentation`: doxygen/annotated.html
37
38.. note::
39    This documentation is generated directly from the source code with doxygen.
40    Since the tools of clang-tools-extra are constantly under active
41    development, what you're about to read is out of date!
42
43
44Indices and tables
45==================
46
47* :ref:`genindex`
48* :ref:`search`
49