================ @@ -89,14 +89,53 @@ 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. It runs a given source file through the Clang +preprocessor, displaying selected information from callback functions overridden +in a PPCallbacks derivation. The output is in a high-level YAML format, ---------------- vbvictor wrote:
I think we can make it even smaller, IMO no need here to tell how it runs so I vote for such text: ``` `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. ``` https://github.com/llvm/llvm-project/pull/148622 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
