Skip to content

Commit 54492c2

Browse files
authored
[clang][docs] Add all clang-tools-extra to 'ClangTools.rst' (#148622)
The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools. Fixes #148538
1 parent 6056f94 commit 54492c2

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

clang/docs/ClangTools.rst

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,50 @@ they'll be tracked here. The focus of this documentation is on the scope
8989
and features of the tools for other tool developers; each tool should
9090
provide its own user-focused documentation.
9191

92-
``clang-tidy``
92+
``Clang-Doc``
93+
-------------
94+
95+
`Clang-Doc <https://clang.llvm.org/extra/clang-doc.html>`_ is a tool for
96+
generating C and C++ documentation from source code and comments.
97+
98+
``Clang-Include-Fixer``
99+
-----------------------
100+
101+
`Clang-Include-Fixer <https://clang.llvm.org/extra/clang-include-fixer.html>`_
102+
is a tool to automate the addition of missing ``#include`` directives in a C++
103+
file. It adds missing namespace qualifiers to unidentified symbols when
104+
necessary and also removes unused headers.
105+
106+
``Clang-Tidy``
93107
--------------
94108

95-
`clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a clang-based C++
109+
`Clang-Tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a Clang-based C++
96110
linter tool. It provides an extensible framework for building compiler-based
97111
static analyses detecting and fixing bug-prone patterns, performance,
98-
portability and maintainability issues.
112+
portability and maintainability issues. It also has checks for modernizing code
113+
to newer language standards.
114+
115+
``Clangd``
116+
----------
117+
118+
`Clangd <https://clangd.llvm.org/>`_ is a language server that can work with
119+
many editors via a plugin. It understands your C++ code and adds smart
120+
features to your editor: code completion, compile errors, go-to-definition and
121+
more.
122+
123+
``Modularize``
124+
--------------
125+
126+
`Modularize <https://clang.llvm.org/extra/modularize.html>`_ is a standalone
127+
tool that checks whether a set of headers provides the consistent definitions
128+
required to use modules.
129+
130+
``pp-trace``
131+
------------
132+
133+
`pp-trace <https://clang.llvm.org/extra/pp-trace.html>`_ is a standalone tool
134+
that traces preprocessor activity. It’s also used as a test of Clang’s
135+
``PPCallbacks`` interface.
99136

100137

101138
Ideas for new Tools

0 commit comments

Comments
 (0)