blob: bf2de7ebfdab7da35caf56c26b05db4ea1a4201b [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
Alexey Samsonov05654ff2013-08-07 08:23:32 +000029 SanitizerSpecialCaseList
Douglas Gregor9bb4a0c2013-03-22 06:21:35 +000030 Modules
Stephen Hines651f13c2014-04-23 16:59:28 -070031 MSVCCompatibility
Dmitri Gribenko1834a042013-01-06 13:38:34 +000032 FAQ
Sean Silvaaaf575b2013-01-02 12:41:24 +000033
34Using Clang as a Library
Sean Silvae132c892013-01-02 21:50:48 +000035========================
Sean Silvaaaf575b2013-01-02 12:41:24 +000036
37.. toctree::
38 :maxdepth: 1
39
40 Tooling
Sean Silvad9186132013-02-19 17:29:01 +000041 ExternalClangExamples
Sean Silvaaaf575b2013-01-02 12:41:24 +000042 IntroductionToTheClangAST
43 LibTooling
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000044 LibFormat
Sean Silva93ca0212012-12-13 01:10:46 +000045 ClangPlugins
Sean Silvaaaf575b2013-01-02 12:41:24 +000046 RAVFrontendAction
47 LibASTMatchersTutorial
48 LibASTMatchers
Sean Silva93ca0212012-12-13 01:10:46 +000049 HowToSetupToolingForLLVM
Sean Silva93ca0212012-12-13 01:10:46 +000050 JSONCompilationDatabase
Sean Silvaaaf575b2013-01-02 12:41:24 +000051
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000052Using Clang Tools
53=================
54
55.. toctree::
56 :maxdepth: 1
57
58 ClangTools
59 ClangCheck
60 ClangFormat
Alexander Kornienko62d06b72013-09-04 15:09:13 +000061 ClangFormatStyleOptions
Daniel Jasper6d5b57a2013-01-09 21:49:28 +000062
Sean Silvaaaf575b2013-01-02 12:41:24 +000063Design Documents
Sean Silvae132c892013-01-02 21:50:48 +000064================
Sean Silvaaaf575b2013-01-02 12:41:24 +000065
66.. toctree::
67 :maxdepth: 1
68
Dmitri Gribenko5cc05802012-12-15 20:41:17 +000069 InternalsManual
Sean Silva0a7d2fe2012-12-21 00:16:53 +000070 DriverInternals
Sean Silvaaaf575b2013-01-02 12:41:24 +000071 PTHInternals
72 PCHInternals
73
74
Sean Silva1c6ee672012-12-12 23:02:30 +000075Indices and tables
76==================
77
78* :ref:`genindex`
79* :ref:`modindex`
80* :ref:`search`
81