blob: bf2de7ebfdab7da35caf56c26b05db4ea1a4201b [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
Peter Collingbourne276be3c2013-08-14 18:54:18 +000027 DataFlowSanitizer
Sergey Matveev072db592013-12-10 20:10:30 +000028 LeakSanitizer
Alexey Samsonov2de68332013-08-07 08:23:32 +000029 SanitizerSpecialCaseList
Douglas Gregorde0beaa2013-03-22 06:21:35 +000030 Modules
Reid Kleckner49133942014-02-28 23:46:04 +000031 MSVCCompatibility
Dmitri Gribenko4077efc2013-01-06 13:38:34 +000032 FAQ
Sean Silvadd9f4062013-01-02 12:41:24 +000033
34Using Clang as a Library
Sean Silvaaaa78ee2013-01-02 21:50:48 +000035========================
Sean Silvadd9f4062013-01-02 12:41:24 +000036
37.. toctree::
38 :maxdepth: 1
39
40 Tooling
Sean Silvaf2a472a2013-02-19 17:29:01 +000041 ExternalClangExamples
Sean Silvadd9f4062013-01-02 12:41:24 +000042 IntroductionToTheClangAST
43 LibTooling
Daniel Jasper85a77c12013-01-09 21:49:28 +000044 LibFormat
Sean Silvabf9b4cd2012-12-13 01:10:46 +000045 ClangPlugins
Sean Silvadd9f4062013-01-02 12:41:24 +000046 RAVFrontendAction
47 LibASTMatchersTutorial
48 LibASTMatchers
Sean Silvabf9b4cd2012-12-13 01:10:46 +000049 HowToSetupToolingForLLVM
Sean Silvabf9b4cd2012-12-13 01:10:46 +000050 JSONCompilationDatabase
Sean Silvadd9f4062013-01-02 12:41:24 +000051
Daniel Jasper85a77c12013-01-09 21:49:28 +000052Using Clang Tools
53=================
54
55.. toctree::
56 :maxdepth: 1
57
58 ClangTools
59 ClangCheck
60 ClangFormat
Alexander Kornienkod278e0e2013-09-04 15:09:13 +000061 ClangFormatStyleOptions
Daniel Jasper85a77c12013-01-09 21:49:28 +000062
Sean Silvadd9f4062013-01-02 12:41:24 +000063Design Documents
Sean Silvaaaa78ee2013-01-02 21:50:48 +000064================
Sean Silvadd9f4062013-01-02 12:41:24 +000065
66.. toctree::
67 :maxdepth: 1
68
Dmitri Gribenkod9d26072012-12-15 20:41:17 +000069 InternalsManual
Sean Silva5f25c502012-12-21 00:16:53 +000070 DriverInternals
Sean Silvadd9f4062013-01-02 12:41:24 +000071 PTHInternals
72 PCHInternals
73
74
Sean Silva99b51c42012-12-12 23:02:30 +000075Indices and tables
76==================
77
78* :ref:`genindex`
79* :ref:`modindex`
80* :ref:`search`
81