llvm-project/clang-tools-extra/docs/index.rst

.. title:: Welcome to Extra Clang Tools's documentation!

Introduction
============
Welcome to the clang-tools-extra project which contains extra tools built using
Clang's tooling APIs.

.. toctree::
   :maxdepth: 1

   ReleaseNotes

Contents
========
.. toctree::
   :maxdepth: 2

   clang-tidy/index
   clang-include-fixer
   modularize
   pp-trace
   clang-rename
   clangd <https://clangd.llvm.org/>
   clang-doc


Doxygen Documentation
=====================
The Doxygen documentation describes the **internal** software that makes up the
tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
documentation contains no instructions about how to use the tools, only the APIs
that make up the software. For usage instructions, please see the user's guide
or reference manual for each tool.

* `Doxygen documentation`_

.. _`Doxygen documentation`: doxygen/annotated.html

.. note::
    This documentation is generated directly from the source code with doxygen.
    Since the tools of clang-tools-extra are constantly under active
    development, what you're about to read is out of date!


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118 2013-02-14 09:34:59 +08:00			`.. title:: Welcome to Extra Clang Tools's documentation!`

Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00			`Introduction`
			`============`
Fix typo. llvm-svn: 256780 2016-01-05 05:25:10 +08:00			`Welcome to the clang-tools-extra project which contains extra tools built using`
Fixed grammar in index.rst Subscribers: arphaman, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D58601 llvm-svn: 354778 2019-02-25 20:49:27 +08:00			`Clang's tooling APIs.`
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118 2013-02-14 09:34:59 +08:00
Add clang-tools-extra release notes llvm-svn: 264531 2016-03-27 13:06:57 +08:00			`.. toctree::`
			`:maxdepth: 1`

			`ReleaseNotes`
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00
			`Contents`
			`========`
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118 2013-02-14 09:34:59 +08:00			`.. toctree::`
[clang-tidy] Updates to documentation: formatting, titles, etc. llvm-svn: 256259 2015-12-23 01:36:49 +08:00			`:maxdepth: 2`
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046 2013-02-26 04:37:03 +08:00
[clang-tidy] Move clang-tidy docs to a separate directory. Create doc files for checks The doc files for checks have been generated from the corresponding header files using the docs/clang-tidy/tools/dump_check_docs.py script. Committing the script as well, but the intention is to move all the user-facing docs from header files to the rST files and add links to .h files appropriately. llvm-svn: 246173 2015-08-28 02:10:07 +08:00			`clang-tidy/index`
Rename directory housing clang-include-fixer to be eponymous Makes the name of this directory consistent with the names of the other directories in clang-tools-extra. Similar to r356254. No intended behavior change. Differential Revision: https://reviews.llvm.org/D59750 llvm-svn: 356897 2019-03-25 22:09:10 +08:00			`clang-include-fixer`
Added modularize documentation. llvm-svn: 191091 2013-09-20 22:40:52 +08:00			`modularize`
pp-trace user documentation - beginnings llvm-svn: 193841 2013-11-01 08:38:04 +08:00			`pp-trace`
[clang-rename] add documentation clang-rename needs at least to have a minimum documentation to provide a small introduction for new users Patch by Kirill Bobyrev! Differential Revision: http://reviews.llvm.org/D22129 llvm-svn: 275388 2016-07-14 17:46:07 +08:00			`clang-rename`
[clangd] Redirect documentation to clangd.llvm.org. Reviewers: hokein Subscribers: ilya-biryukov, MaskRay, jkorous, arphaman, kadircet, usaxena95, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D76053 2020-03-12 17:55:31 +08:00			`clangd <https://clangd.llvm.org/>`
[docs] Adding clang-doc to CTE toctree to fix docs build error llvm-svn: 327333 2018-03-13 05:39:01 +08:00			`clang-doc`
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118 2013-02-14 09:34:59 +08:00

Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00			`Doxygen Documentation`
			`=====================`
[docs] Clarify wording. "This documentation" could be construed as the entire c-t-e docs (despite being under a doxygen heading; people read "locally" sometimes), which gives a bad impression. llvm-svn: 176849 2013-03-12 10:40:05 +08:00			`The Doxygen documentation describes the internal software that makes up the`
[clang-tools-extra] Text formatting llvm-svn: 256253 2015-12-23 01:08:57 +08:00			`tools of clang-tools-extra, not the external use of these tools. The Doxygen`
			`documentation contains no instructions about how to use the tools, only the APIs`
			`that make up the software. For usage instructions, please see the user's guide`
			`or reference manual for each tool.`
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00
			* `Doxygen documentation`_

Point doxygen link to somthing useful. llvm-svn: 190607 2013-09-12 23:26:44 +08:00			.. _`Doxygen documentation`: doxygen/annotated.html
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00
[docs] Remove doubled spaces Reviewers: aaron.ballman Subscribers: nemanjai, cfe-commits Differential Revision: https://reviews.llvm.org/D26798 llvm-svn: 287226 2016-11-17 22:26:45 +08:00			`.. note::`
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00			`This documentation is generated directly from the source code with doxygen.`
[clang-tools-extra] Text formatting llvm-svn: 256253 2015-12-23 01:08:57 +08:00			`Since the tools of clang-tools-extra are constantly under active`
			`development, what you're about to read is out of date!`
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267 2013-03-01 00:46:40 +08:00
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118 2013-02-14 09:34:59 +08:00
			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`search`