blob: 296054766d68588e1b91e1a63dfc9a99de28f890 [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
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080027 UndefinedBehaviorSanitizer
Peter Collingbourne5d27a512013-08-14 18:54:18 +000028 DataFlowSanitizer
Sergey Matveevf6578462013-12-10 20:13:58 +000029 LeakSanitizer
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -070030 SanitizerCoverage
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070031 SanitizerStats
Alexey Samsonov05654ff2013-08-07 08:23:32 +000032 SanitizerSpecialCaseList
Stephen Hines0e2c34f2015-03-23 12:09:02 -070033 ControlFlowIntegrity
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070034 LTOVisibility
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -070035 SafeStack
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070036 SourceBasedCodeCoverage
Douglas Gregor9bb4a0c2013-03-22 06:21:35 +000037 Modules
Stephen Hines651f13c2014-04-23 16:59:28 -070038 MSVCCompatibility
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080039 CommandGuide/index
Dmitri Gribenko1834a042013-01-06 13:38:34 +000040 FAQ
Sean Silvaaaf575b2013-01-02 12:41:24 +000041
42Using Clang as a Library
Sean Silvae132c892013-01-02 21:50:48 +000043========================
Sean Silvaaaf575b2013-01-02 12:41:24 +000044
45.. toctree::
46 :maxdepth: 1
47
48 Tooling
Sean Silvad9186132013-02-19 17:29:01 +000049 ExternalClangExamples
Sean Silvaaaf575b2013-01-02 12:41:24 +000050 IntroductionToTheClangAST
51 LibTooling
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000052 LibFormat
Sean Silva93ca0212012-12-13 01:10:46 +000053 ClangPlugins
Sean Silvaaaf575b2013-01-02 12:41:24 +000054 RAVFrontendAction
55 LibASTMatchersTutorial
56 LibASTMatchers
Sean Silva93ca0212012-12-13 01:10:46 +000057 HowToSetupToolingForLLVM
Sean Silva93ca0212012-12-13 01:10:46 +000058 JSONCompilationDatabase
Sean Silvaaaf575b2013-01-02 12:41:24 +000059
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000060Using Clang Tools
61=================
62
63.. toctree::
64 :maxdepth: 1
65
66 ClangTools
67 ClangCheck
68 ClangFormat
Alexander Kornienko62d06b72013-09-04 15:09:13 +000069 ClangFormatStyleOptions
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000070
Sean Silvaaaf575b2013-01-02 12:41:24 +000071Design Documents
Sean Silvae132c892013-01-02 21:50:48 +000072================
Sean Silvaaaf575b2013-01-02 12:41:24 +000073
74.. toctree::
75 :maxdepth: 1
76
Dmitri Gribenko5cc05802012-12-15 20:41:17 +000077 InternalsManual
Sean Silva0a7d2fe2012-12-21 00:16:53 +000078 DriverInternals
Sean Silvaaaf575b2013-01-02 12:41:24 +000079 PTHInternals
80 PCHInternals
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070081 ItaniumMangleAbiTags
Sean Silvaaaf575b2013-01-02 12:41:24 +000082
83
Sean Silva1c6ee672012-12-12 23:02:30 +000084Indices and tables
85==================
86
87* :ref:`genindex`
88* :ref:`modindex`
89* :ref:`search`
90