Skip to content

[clang][docs] Add all clang-tools-extra to 'ClangTools.rst' #148622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions clang/docs/ClangTools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,50 @@ they'll be tracked here. The focus of this documentation is on the scope
and features of the tools for other tool developers; each tool should
provide its own user-focused documentation.

``clang-tidy``
``Clang-Doc``
-------------

`Clang-Doc <https://clang.llvm.org/extra/clang-doc.html>`_ is a tool for
generating C and C++ documentation from source code and comments.

``Clang-Include-Fixer``
-----------------------

`Clang-Include-Fixer <https://clang.llvm.org/extra/clang-include-fixer.html>`_
is a tool to automate the addition of missing ``#include`` directives in a C++
file. It adds missing namespace qualifiers to unidentified symbols when
necessary and also removes unused headers.

``Clang-Tidy``
--------------

`clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a clang-based C++
`Clang-Tidy <https://clang.llvm.org/extra/clang-tidy/>`_ is a Clang-based C++
linter tool. It provides an extensible framework for building compiler-based
static analyses detecting and fixing bug-prone patterns, performance,
portability and maintainability issues.
portability and maintainability issues. It also has checks for modernizing code
to newer language standards.

``Clangd``
----------

`Clangd <https://clangd.llvm.org/>`_ is a language server that can work with
many editors via a plugin. It understands your C++ code and adds smart
features to your editor: code completion, compile errors, go-to-definition and
more.

``Modularize``
--------------

`Modularize <https://clang.llvm.org/extra/modularize.html>`_ is a standalone
tool that checks whether a set of headers provides the consistent definitions
required to use modules.

``pp-trace``
------------

`pp-trace <https://clang.llvm.org/extra/pp-trace.html>`_ is a standalone tool
that traces preprocessor activity. It’s also used as a test of Clang’s
``PPCallbacks`` interface.


Ideas for new Tools
Expand Down
Loading