annotate clang-tools-extra/docs/index.rst @ 214:0cf2d4ade63d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Tue, 13 Jul 2021 09:53:52 +0900
parents 0572611fdcc8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 .. title:: Welcome to Extra Clang Tools's documentation!
anatofuz
parents:
diff changeset
2
anatofuz
parents:
diff changeset
3 Introduction
anatofuz
parents:
diff changeset
4 ============
anatofuz
parents:
diff changeset
5 Welcome to the clang-tools-extra project which contains extra tools built using
anatofuz
parents:
diff changeset
6 Clang's tooling APIs.
anatofuz
parents:
diff changeset
7
anatofuz
parents:
diff changeset
8 .. toctree::
anatofuz
parents:
diff changeset
9 :maxdepth: 1
anatofuz
parents:
diff changeset
10
anatofuz
parents:
diff changeset
11 ReleaseNotes
anatofuz
parents:
diff changeset
12
anatofuz
parents:
diff changeset
13 Contents
anatofuz
parents:
diff changeset
14 ========
anatofuz
parents:
diff changeset
15 .. toctree::
anatofuz
parents:
diff changeset
16 :maxdepth: 2
anatofuz
parents:
diff changeset
17
anatofuz
parents:
diff changeset
18 clang-tidy/index
anatofuz
parents:
diff changeset
19 clang-include-fixer
anatofuz
parents:
diff changeset
20 modularize
anatofuz
parents:
diff changeset
21 pp-trace
anatofuz
parents:
diff changeset
22 clang-rename
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
23 clangd <https://clangd.llvm.org/>
150
anatofuz
parents:
diff changeset
24 clang-doc
anatofuz
parents:
diff changeset
25
anatofuz
parents:
diff changeset
26
anatofuz
parents:
diff changeset
27 Doxygen Documentation
anatofuz
parents:
diff changeset
28 =====================
anatofuz
parents:
diff changeset
29 The Doxygen documentation describes the **internal** software that makes up the
anatofuz
parents:
diff changeset
30 tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
anatofuz
parents:
diff changeset
31 documentation contains no instructions about how to use the tools, only the APIs
anatofuz
parents:
diff changeset
32 that make up the software. For usage instructions, please see the user's guide
anatofuz
parents:
diff changeset
33 or reference manual for each tool.
anatofuz
parents:
diff changeset
34
anatofuz
parents:
diff changeset
35 * `Doxygen documentation`_
anatofuz
parents:
diff changeset
36
anatofuz
parents:
diff changeset
37 .. _`Doxygen documentation`: doxygen/annotated.html
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 .. note::
anatofuz
parents:
diff changeset
40 This documentation is generated directly from the source code with doxygen.
anatofuz
parents:
diff changeset
41 Since the tools of clang-tools-extra are constantly under active
anatofuz
parents:
diff changeset
42 development, what you're about to read is out of date!
anatofuz
parents:
diff changeset
43
anatofuz
parents:
diff changeset
44
anatofuz
parents:
diff changeset
45 Indices and tables
anatofuz
parents:
diff changeset
46 ==================
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 * :ref:`genindex`
anatofuz
parents:
diff changeset
49 * :ref:`search`