clang-tools-extra/docs/index.rst

   1 .. title:: Welcome to Extra Clang Tools's documentation!
   2
   3 Introduction
   4 ============
   5 Welcome to the clang-tools-extra project which contains extra tools built using
   6 Clang's tooling APIs.
   7
   8 .. toctree::
   9    :maxdepth: 1
  10
  11    ReleaseNotes
  12
  13 Contents
  14 ========
  15 .. toctree::
  16    :maxdepth: 2
  17
  18    clang-tidy/index
  19    clang-include-fixer
  20    modularize
  21    pp-trace
  22    clang-rename
  23    clangd <https://clangd.llvm.org/>
  24    clang-doc
  25
  26
  27 Doxygen Documentation
  28 =====================
  29 The Doxygen documentation describes the **internal** software that makes up the
  30 tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
  31 documentation contains no instructions about how to use the tools, only the APIs
  32 that make up the software. For usage instructions, please see the user's guide
  33 or reference manual for each tool.
  34
  35 * `Doxygen documentation`_
  36
  37 .. _`Doxygen documentation`: doxygen/annotated.html
  38
  39 .. note::
  40     This documentation is generated directly from the source code with doxygen.
  41     Since the tools of clang-tools-extra are constantly under active
  42     development, what you're about to read is out of date!
  43
  44
  45 Indices and tables
  46 ==================
  47
  48 * :ref:`genindex`
  49 * :ref:`search`