| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 1 | .. Extra Clang Tools documentation master file, created by |
| 2 | sphinx-quickstart on Wed Feb 13 10:00:18 2013. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| 6 | .. title:: Welcome to Extra Clang Tools's documentation! |
| 7 | |
| Dmitri Gribenko | f38da0d | 2013-02-28 16:46:40 +0000 | [diff] [blame] | 8 | Introduction |
| 9 | ============ |
| 10 | Welcome to clang-tools-exta project which contains extra tools built using Clang's tooling API's |
| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 11 | |
| Dmitri Gribenko | f38da0d | 2013-02-28 16:46:40 +0000 | [diff] [blame] | 12 | |
| 13 | Contents |
| 14 | ======== |
| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 15 | .. toctree:: |
| Edwin Vane | 30f7004 | 2013-02-25 20:37:03 +0000 | [diff] [blame] | 16 | :maxdepth: 1 |
| 17 | |
| Chandler Carruth | d9063c4 | 2013-09-04 17:35:07 +0000 | [diff] [blame] | 18 | clang-modernize |
| Alexander Kornienko | 84e30a7 | 2014-02-25 16:46:13 +0000 | [diff] [blame] | 19 | clang-tidy |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 20 | modularize |
| John Thompson | 5052eb7 | 2013-11-01 00:38:04 +0000 | [diff] [blame] | 21 | pp-trace |
| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 22 | |
| 23 | |
| Dmitri Gribenko | f38da0d | 2013-02-28 16:46:40 +0000 | [diff] [blame] | 24 | Doxygen Documentation |
| 25 | ===================== |
| Sean Silva | a7aedfa | 2013-03-12 02:40:05 +0000 | [diff] [blame] | 26 | The Doxygen documentation describes the **internal** software that makes up the |
| 27 | tools of clang-tools-extra, not the **external** use of these tools. The |
| 28 | Doxygen documentation contains no instructions about how to use the tools, |
| 29 | only the APIs that make up the software. For usage instructions, please see |
| 30 | the user's guide or reference manual for each tool. |
| Dmitri Gribenko | f38da0d | 2013-02-28 16:46:40 +0000 | [diff] [blame] | 31 | |
| 32 | * `Doxygen documentation`_ |
| 33 | |
| Ariel J. Bernal | dfa4c75 | 2013-09-12 15:26:44 +0000 | [diff] [blame] | 34 | .. _`Doxygen documentation`: doxygen/annotated.html |
| Dmitri Gribenko | f38da0d | 2013-02-28 16:46:40 +0000 | [diff] [blame] | 35 | |
| 36 | .. note:: |
| 37 | This documentation is generated directly from the source code with doxygen. |
| 38 | Since the tools of clang-tools-extra are constantly under active development, |
| 39 | what you're about to read is out of date! |
| 40 | |
| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 41 | |
| 42 | Indices and tables |
| 43 | ================== |
| 44 | |
| 45 | * :ref:`genindex` |
| Edwin Vane | 7f99907 | 2013-02-14 01:34:59 +0000 | [diff] [blame] | 46 | * :ref:`search` |