Skip to content

Commit ccbbe50

Browse files
committed
[clang][docs] Add all clang-tools-extra
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 c384ec4 commit ccbbe50

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

clang/docs/ClangTools.rst

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,49 @@ 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+
automates the addition of missing ``#include`` directives in a C++ file. It adds
103+
missing namespace qualifiers to unidentified symbols when necessary.
104+
105+
``Clang-Tidy``
93106
--------------
94107

95-
`clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a clang-based C++
108+
`Clang-Tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a clang-based C++
96109
linter tool. It provides an extensible framework for building compiler-based
97110
static analyses detecting and fixing bug-prone patterns, performance,
98111
portability and maintainability issues.
99112

113+
``Clangd``
114+
----------
115+
116+
`Clangd <https://clangd.llvm.org/>`_ is a language server that can work with
117+
many editors via a plugin. It understands your C++ code and adds smart
118+
features to your editor: code completion, compile errors, go-to-definition and
119+
more.
120+
121+
``Modularize``
122+
--------------
123+
124+
`Modularize <https://clang.llvm.org/extra/modularize.html>`_ is a standalone
125+
tool that checks whether a set of headers provides the consistent definitions
126+
required to use modules.
127+
128+
``pp-trace``
129+
------------
130+
131+
`pp-trace <https://clang.llvm.org/extra/pp-trace.html>`_ is a standalone tool
132+
that traces preprocessor activity. It’s also used as a test of Clang’s
133+
PPCallbacks interface.
134+
100135

101136
Ideas for new Tools
102137
===================

0 commit comments

Comments
 (0)