Author: Manas Date: 2025-07-20T01:18:24+03:00 New Revision: 54492c231c5d9091d086bfb767423415ea6bd0bc
URL: https://github.com/llvm/llvm-project/commit/54492c231c5d9091d086bfb767423415ea6bd0bc DIFF: https://github.com/llvm/llvm-project/commit/54492c231c5d9091d086bfb767423415ea6bd0bc.diff LOG: [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 Added: Modified: clang/docs/ClangTools.rst Removed: ################################################################################ diff --git a/clang/docs/ClangTools.rst b/clang/docs/ClangTools.rst index 60e21590f9eb3..3216328bbb6a6 100644 --- a/clang/docs/ClangTools.rst +++ b/clang/docs/ClangTools.rst @@ -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 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
