blob: 81a15b8e188771975435bbc5e09473565e3af921 [file] [log] [blame]
Sean Silva99b51c42012-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 Silvaaaa78ee2013-01-02 21:50:48 +00006.. title:: Welcome to Clang's documentation!
Sean Silva99b51c42012-12-12 23:02:30 +00007
Sean Silva99b51c42012-12-12 23:02:30 +00008.. toctree::
Sean Silvad2a98e62013-01-02 12:39:50 +00009 :maxdepth: 1
Sean Silva99b51c42012-12-12 23:02:30 +000010
Sean Silvadd9f4062013-01-02 12:41:24 +000011 ReleaseNotes
12
13Using Clang as a Compiler
Sean Silvaaaa78ee2013-01-02 21:50:48 +000014=========================
Sean Silvadd9f4062013-01-02 12:41:24 +000015
16.. toctree::
17 :maxdepth: 1
18
19 UsersManual
Sean Silvaf380e0e2013-01-02 21:03:11 +000020 LanguageExtensions
Aaron Ballman5142a2c2014-02-19 23:09:37 +000021 AttributeReference
Renato Golinf70e35d2013-09-08 20:44:39 +000022 CrossCompilation
DeLesley Hutchinsc51e08c2014-02-18 19:42:01 +000023 ThreadSafetyAnalysis
Sean Silvabf9b4cd2012-12-13 01:10:46 +000024 AddressSanitizer
Dmitri Gribenkodd20f2c2012-12-23 18:35:58 +000025 ThreadSanitizer
26 MemorySanitizer
Alexey Samsonov778fc722015-12-04 17:30:29 +000027 UndefinedBehaviorSanitizer
Peter Collingbourne276be3c2013-08-14 18:54:18 +000028 DataFlowSanitizer
Sergey Matveev072db592013-12-10 20:10:30 +000029 LeakSanitizer
Sergey Matveev07e2d282015-04-23 20:40:04 +000030 SanitizerCoverage
Peter Collingbournedc134532016-01-16 00:31:22 +000031 SanitizerStats
Alexey Samsonov2de68332013-08-07 08:23:32 +000032 SanitizerSpecialCaseList
Peter Collingbournea4ccff32015-02-20 20:30:56 +000033 ControlFlowIntegrity
Peter Collingbournec4122c12015-06-15 21:08:13 +000034 SafeStack
Douglas Gregorde0beaa2013-03-22 06:21:35 +000035 Modules
Reid Kleckner49133942014-02-28 23:46:04 +000036 MSVCCompatibility
Andrew Wilkins6238c6f2015-06-30 02:52:38 +000037 CommandGuide/index
Dmitri Gribenko4077efc2013-01-06 13:38:34 +000038 FAQ
Sean Silvadd9f4062013-01-02 12:41:24 +000039
40Using Clang as a Library
Sean Silvaaaa78ee2013-01-02 21:50:48 +000041========================
Sean Silvadd9f4062013-01-02 12:41:24 +000042
43.. toctree::
44 :maxdepth: 1
45
46 Tooling
Sean Silvaf2a472a2013-02-19 17:29:01 +000047 ExternalClangExamples
Sean Silvadd9f4062013-01-02 12:41:24 +000048 IntroductionToTheClangAST
49 LibTooling
Daniel Jasper85a77c12013-01-09 21:49:28 +000050 LibFormat
Sean Silvabf9b4cd2012-12-13 01:10:46 +000051 ClangPlugins
Sean Silvadd9f4062013-01-02 12:41:24 +000052 RAVFrontendAction
53 LibASTMatchersTutorial
54 LibASTMatchers
Sean Silvabf9b4cd2012-12-13 01:10:46 +000055 HowToSetupToolingForLLVM
Sean Silvabf9b4cd2012-12-13 01:10:46 +000056 JSONCompilationDatabase
Sean Silvadd9f4062013-01-02 12:41:24 +000057
Daniel Jasper85a77c12013-01-09 21:49:28 +000058Using Clang Tools
59=================
60
61.. toctree::
62 :maxdepth: 1
63
64 ClangTools
65 ClangCheck
66 ClangFormat
Alexander Kornienkod278e0e2013-09-04 15:09:13 +000067 ClangFormatStyleOptions
Daniel Jasper85a77c12013-01-09 21:49:28 +000068
Sean Silvadd9f4062013-01-02 12:41:24 +000069Design Documents
Sean Silvaaaa78ee2013-01-02 21:50:48 +000070================
Sean Silvadd9f4062013-01-02 12:41:24 +000071
72.. toctree::
73 :maxdepth: 1
74
Dmitri Gribenkod9d26072012-12-15 20:41:17 +000075 InternalsManual
Sean Silva5f25c502012-12-21 00:16:53 +000076 DriverInternals
Sean Silvadd9f4062013-01-02 12:41:24 +000077 PTHInternals
78 PCHInternals
79
80
Sean Silva99b51c42012-12-12 23:02:30 +000081Indices and tables
82==================
83
84* :ref:`genindex`
85* :ref:`modindex`
86* :ref:`search`
87