[clang] [clang][docs] Add all clang-tools-extra (PR #148622)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Jul 16 03:04:14 PDT 2025
https://github.com/weirdsmiley updated https://github.com/llvm/llvm-project/pull/148622
>From ccbbe50c749274b1e69758f30b12a5d5586e344b Mon Sep 17 00:00:00 2001
From: Manas <manas18244 at iiitd.ac.in>
Date: Mon, 14 Jul 2025 18:08:36 +0530
Subject: [PATCH] [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
---
clang/docs/ClangTools.rst | 39 +++++++++++++++++++++++++++++++++++++--
1 file changed, 37 insertions(+), 2 deletions(-)
diff --git a/clang/docs/ClangTools.rst b/clang/docs/ClangTools.rst
index 60e21590f9eb3..6ea5c9aafab43 100644
--- a/clang/docs/ClangTools.rst
+++ b/clang/docs/ClangTools.rst
@@ -89,14 +89,49 @@ 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>`_
+automates the addition of missing ``#include`` directives in a C++ file. It adds
+missing namespace qualifiers to unidentified symbols when necessary.
+
+``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.
+``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
===================
More information about the cfe-commits
mailing list