blob: dec2bc828c1c68e82c70b4e24f09303e609a6f30 [file] [log] [blame]
Sean Silva1c6ee672012-12-12 23:02:30 +00001.. Clang documentation master file, created by
2 sphinx-quickstart on Sun Dec 9 20:01:55 2012.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
Sean Silvae132c892013-01-02 21:50:48 +00006.. title:: Welcome to Clang's documentation!
Sean Silva1c6ee672012-12-12 23:02:30 +00007
Sean Silva1c6ee672012-12-12 23:02:30 +00008.. toctree::
Sean Silva112f7782013-01-02 12:39:50 +00009 :maxdepth: 1
Sean Silva1c6ee672012-12-12 23:02:30 +000010
Sean Silvaaaf575b2013-01-02 12:41:24 +000011 ReleaseNotes
12
13Using Clang as a Compiler
Sean Silvae132c892013-01-02 21:50:48 +000014=========================
Sean Silvaaaf575b2013-01-02 12:41:24 +000015
16.. toctree::
17 :maxdepth: 1
18
19 UsersManual
Sean Silvaa0c392d2013-01-02 21:03:11 +000020 LanguageExtensions
Stephen Hines651f13c2014-04-23 16:59:28 -070021 AttributeReference
Renato Golinf54e02f2013-09-08 20:44:39 +000022 CrossCompilation
Stephen Hines651f13c2014-04-23 16:59:28 -070023 ThreadSafetyAnalysis
Sean Silva93ca0212012-12-13 01:10:46 +000024 AddressSanitizer
Dmitri Gribenko5c0de4c2012-12-23 18:35:58 +000025 ThreadSanitizer
26 MemorySanitizer
Peter Collingbourne5d27a512013-08-14 18:54:18 +000027 DataFlowSanitizer
Sergey Matveevf6578462013-12-10 20:13:58 +000028 LeakSanitizer
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -070029 SanitizerCoverage
Alexey Samsonov05654ff2013-08-07 08:23:32 +000030 SanitizerSpecialCaseList
Stephen Hines0e2c34f2015-03-23 12:09:02 -070031 ControlFlowIntegrity
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -070032 SafeStack
Douglas Gregor9bb4a0c2013-03-22 06:21:35 +000033 Modules
Stephen Hines651f13c2014-04-23 16:59:28 -070034 MSVCCompatibility
Dmitri Gribenko1834a042013-01-06 13:38:34 +000035 FAQ
Sean Silvaaaf575b2013-01-02 12:41:24 +000036
37Using Clang as a Library
Sean Silvae132c892013-01-02 21:50:48 +000038========================
Sean Silvaaaf575b2013-01-02 12:41:24 +000039
40.. toctree::
41 :maxdepth: 1
42
43 Tooling
Sean Silvad9186132013-02-19 17:29:01 +000044 ExternalClangExamples
Sean Silvaaaf575b2013-01-02 12:41:24 +000045 IntroductionToTheClangAST
46 LibTooling
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000047 LibFormat
Sean Silva93ca0212012-12-13 01:10:46 +000048 ClangPlugins
Sean Silvaaaf575b2013-01-02 12:41:24 +000049 RAVFrontendAction
50 LibASTMatchersTutorial
51 LibASTMatchers
Sean Silva93ca0212012-12-13 01:10:46 +000052 HowToSetupToolingForLLVM
Sean Silva93ca0212012-12-13 01:10:46 +000053 JSONCompilationDatabase
Sean Silvaaaf575b2013-01-02 12:41:24 +000054
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000055Using Clang Tools
56=================
57
58.. toctree::
59 :maxdepth: 1
60
61 ClangTools
62 ClangCheck
63 ClangFormat
Alexander Kornienko62d06b72013-09-04 15:09:13 +000064 ClangFormatStyleOptions
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000065
Sean Silvaaaf575b2013-01-02 12:41:24 +000066Design Documents
Sean Silvae132c892013-01-02 21:50:48 +000067================
Sean Silvaaaf575b2013-01-02 12:41:24 +000068
69.. toctree::
70 :maxdepth: 1
71
Dmitri Gribenko5cc05802012-12-15 20:41:17 +000072 InternalsManual
Sean Silva0a7d2fe2012-12-21 00:16:53 +000073 DriverInternals
Sean Silvaaaf575b2013-01-02 12:41:24 +000074 PTHInternals
75 PCHInternals
76
77
Sean Silva1c6ee672012-12-12 23:02:30 +000078Indices and tables
79==================
80
81* :ref:`genindex`
82* :ref:`modindex`
83* :ref:`search`
84