xref: /llvm-project/clang/docs/index.rst (revision 822954b4a97753b0c7accc606287529518e9d425)
1.. 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
6.. title:: Welcome to Clang's documentation!
7
8.. toctree::
9   :maxdepth: 1
10
11   ReleaseNotes
12
13Using Clang as a Compiler
14=========================
15
16.. toctree::
17   :maxdepth: 1
18
19   UsersManual
20   Toolchain
21   LanguageExtensions
22   ClangCommandLineReference
23   AttributeReference
24   DiagnosticsReference
25   WarningSuppressionMappings
26   CrossCompilation
27   ClangStaticAnalyzer
28   ThreadSafetyAnalysis
29   SafeBuffers
30   DataFlowAnalysisIntro
31   FunctionEffectAnalysis
32   AddressSanitizer
33   ThreadSanitizer
34   MemorySanitizer
35   UndefinedBehaviorSanitizer
36   DataFlowSanitizer
37   LeakSanitizer
38   TypeSanitizer
39   RealtimeSanitizer
40   SanitizerCoverage
41   SanitizerStats
42   SanitizerSpecialCaseList
43   BoundsSafety
44   BoundsSafetyAdoptionGuide
45   BoundsSafetyImplPlans
46   ControlFlowIntegrity
47   LTOVisibility
48   SafeStack
49   ShadowCallStack
50   SourceBasedCodeCoverage
51   StandardCPlusPlusModules
52   Modules
53   MSVCCompatibility
54   MisExpect
55   OpenCLSupport
56   OpenMPSupport
57   SYCLSupport
58   HIPSupport
59   HLSL/HLSLDocs
60   ThinLTO
61   APINotes
62   DebuggingCoroutines
63   AMDGPUSupport
64   CommandGuide/index
65   FAQ
66
67Using Clang as a Library
68========================
69
70.. toctree::
71   :maxdepth: 1
72
73   Tooling
74   ExternalClangExamples
75   IntroductionToTheClangAST
76   LibTooling
77   LibClang
78   LibFormat
79   ClangPlugins
80   RAVFrontendAction
81   LibASTMatchersTutorial
82   LibASTMatchers
83   ClangTransformerTutorial
84   LibASTImporter
85   HowToSetupToolingForLLVM
86   JSONCompilationDatabase
87   RefactoringEngine
88
89Using Clang Tools
90=================
91
92.. toctree::
93   :maxdepth: 1
94
95   ClangTools
96   ClangCheck
97   ClangFormat
98   ClangFormatStyleOptions
99   ClangLinkerWrapper
100   ClangNVLinkWrapper
101   ClangOffloadBundler
102   ClangOffloadPackager
103   ClangRepl
104   ClangSYCLLinker
105
106Design Documents
107================
108
109.. toctree::
110   :maxdepth: 1
111
112   Maintainers
113   InternalsManual
114   DriverInternals
115   Multilib
116   OffloadingDesign
117   PCHInternals
118   ItaniumMangleAbiTags
119   HardwareAssistedAddressSanitizerDesign.rst
120   ConstantInterpreter
121
122
123Indices and tables
124==================
125
126* :ref:`genindex`
127* :ref:`search`
128
129