diff options
Diffstat (limited to 'clang-tools-extra/docs/index.rst')
| -rw-r--r-- | clang-tools-extra/docs/index.rst | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/clang-tools-extra/docs/index.rst b/clang-tools-extra/docs/index.rst index d39f54c3e3a..26e8398af72 100644 --- a/clang-tools-extra/docs/index.rst +++ b/clang-tools-extra/docs/index.rst @@ -5,14 +5,36 @@ .. title:: Welcome to Extra Clang Tools's documentation! -Contents: +Introduction +============ +Welcome to clang-tools-exta project which contains extra tools built using Clang's tooling API's + +Contents +======== .. toctree:: :maxdepth: 1 cpp11-migrate +Doxygen Documentation +===================== +This documentation describes the **internal** software that makes up the +tools of clang-tools-extra, not the **external** use of these tools. There +are no instructions here on 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/index.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 ================== |
