aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 8e6beb35a60918c0ba742447f95ba837fb0f664a (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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.. Extra Clang Tools documentation master file, created by
   sphinx-quickstart on Wed Feb 13 10:00:18 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. title:: Welcome to Extra Clang Tools's documentation!

Introduction
============
Welcome to the clang-tools-extra project which contains extra tools built using
Clang's tooling API's.

.. toctree::
   :maxdepth: 1

   ReleaseNotes

Contents
========
.. toctree::
   :maxdepth: 2

   clang-tidy/index
   include-fixer
   modularize
   pp-trace
   clang-rename
   clangd
   clang-doc


Doxygen Documentation
=====================
The Doxygen documentation describes the **internal** software that makes up the
tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
documentation contains no instructions about how to use the tools, only the APIs
that make up the software. For usage instructions, please see the user's guide
or reference manual for each tool.

* `Doxygen documentation`_

.. _`Doxygen documentation`: doxygen/annotated.html

.. note::
    This documentation is generated directly from the source code with doxygen.
    Since the tools of clang-tools-extra are constantly under active
    development, what you're about to read is out of date!


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`