2013-02-14 09:34:59 +08:00
|
|
|
.. Extra Clang Tools documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Wed Feb 13 10:00:18 2013.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
|
|
|
|
.. title:: Welcome to Extra Clang Tools's documentation!
|
|
|
|
|
|
2013-03-01 00:46:40 +08:00
|
|
|
Introduction
|
|
|
|
|
============
|
2016-01-05 05:25:10 +08:00
|
|
|
Welcome to the clang-tools-extra project which contains extra tools built using
|
2015-12-23 01:08:57 +08:00
|
|
|
Clang's tooling API's.
|
2013-02-14 09:34:59 +08:00
|
|
|
|
2016-03-27 13:06:57 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
ReleaseNotes
|
2013-03-01 00:46:40 +08:00
|
|
|
|
|
|
|
|
Contents
|
|
|
|
|
========
|
2013-02-14 09:34:59 +08:00
|
|
|
.. toctree::
|
2015-12-23 01:36:49 +08:00
|
|
|
:maxdepth: 2
|
2013-02-26 04:37:03 +08:00
|
|
|
|
2015-08-28 02:10:07 +08:00
|
|
|
clang-tidy/index
|
2016-05-11 17:44:10 +08:00
|
|
|
include-fixer
|
2013-09-20 22:40:52 +08:00
|
|
|
modularize
|
2013-11-01 08:38:04 +08:00
|
|
|
pp-trace
|
2016-07-14 17:46:07 +08:00
|
|
|
clang-rename
|
2017-05-05 03:57:53 +08:00
|
|
|
clangd
|
2013-02-14 09:34:59 +08:00
|
|
|
|
|
|
|
|
|
2013-03-01 00:46:40 +08:00
|
|
|
Doxygen Documentation
|
|
|
|
|
=====================
|
2013-03-12 10:40:05 +08:00
|
|
|
The Doxygen documentation describes the **internal** software that makes up the
|
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.
|
2013-03-01 00:46:40 +08:00
|
|
|
|
|
|
|
|
* `Doxygen documentation`_
|
|
|
|
|
|
2013-09-12 23:26:44 +08:00
|
|
|
.. _`Doxygen documentation`: doxygen/annotated.html
|
2013-03-01 00:46:40 +08:00
|
|
|
|
2016-11-17 22:26:45 +08:00
|
|
|
.. note::
|
2013-03-01 00:46:40 +08:00
|
|
|
This documentation is generated directly from the source code with doxygen.
|
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!
|
2013-03-01 00:46:40 +08:00
|
|
|
|
2013-02-14 09:34:59 +08:00
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
