xref: /openbsd-src/gnu/llvm/clang/docs/index.rst (revision 12c855180aad702bbcca06e0398d774beeafb155)
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   CrossCompilation
26   ClangStaticAnalyzer
27   ThreadSafetyAnalysis
28   DataFlowAnalysisIntro
29   AddressSanitizer
30   ThreadSanitizer
31   MemorySanitizer
32   UndefinedBehaviorSanitizer
33   DataFlowSanitizer
34   LeakSanitizer
35   SanitizerCoverage
36   SanitizerStats
37   SanitizerSpecialCaseList
38   ControlFlowIntegrity
39   LTOVisibility
40   SafeStack
41   ShadowCallStack
42   SourceBasedCodeCoverage
43   StandardCPlusPlusModules
44   Modules
45   MSVCCompatibility
46   MisExpect
47   OpenCLSupport
48   OpenMPSupport
49   SYCLSupport
50   HLSL/HLSLDocs
51   ThinLTO
52   APINotes
53   DebuggingCoroutines
54   CommandGuide/index
55   FAQ
56
57Using Clang as a Library
58========================
59
60.. toctree::
61   :maxdepth: 1
62
63   Tooling
64   ExternalClangExamples
65   IntroductionToTheClangAST
66   LibTooling
67   LibFormat
68   ClangPlugins
69   RAVFrontendAction
70   LibASTMatchersTutorial
71   LibASTMatchers
72   ClangTransformerTutorial
73   LibASTImporter
74   HowToSetupToolingForLLVM
75   JSONCompilationDatabase
76   RefactoringEngine
77
78Using Clang Tools
79=================
80
81.. toctree::
82   :maxdepth: 1
83
84   ClangTools
85   ClangCheck
86   ClangFormat
87   ClangFormatStyleOptions
88   ClangFormattedStatus
89   ClangLinkerWrapper
90   ClangOffloadBundler
91   ClangOffloadPackager
92   ClangRepl
93
94Design Documents
95================
96
97.. toctree::
98   :maxdepth: 1
99
100   CodeOwners
101   InternalsManual
102   DriverInternals
103   OffloadingDesign
104   PCHInternals
105   ItaniumMangleAbiTags
106   HardwareAssistedAddressSanitizerDesign.rst
107   ConstantInterpreter
108
109
110Indices and tables
111==================
112
113* :ref:`genindex`
114* :ref:`search`
115
116