clang/docs/index.rst

   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
  13 Using 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    RealtimeSanitizer
  39    SanitizerCoverage
  40    SanitizerStats
  41    SanitizerSpecialCaseList
  42    BoundsSafety
  43    BoundsSafetyImplPlans
  44    ControlFlowIntegrity
  45    LTOVisibility
  46    SafeStack
  47    ShadowCallStack
  48    SourceBasedCodeCoverage
  49    StandardCPlusPlusModules
  50    Modules
  51    MSVCCompatibility
  52    MisExpect
  53    OpenCLSupport
  54    OpenMPSupport
  55    SYCLSupport
  56    HIPSupport
  57    HLSL/HLSLDocs
  58    ThinLTO
  59    APINotes
  60    DebuggingCoroutines
  61    AMDGPUSupport
  62    CommandGuide/index
  63    FAQ
  64
  65 Using Clang as a Library
  66 ========================
  67
  68 .. toctree::
  69    :maxdepth: 1
  70
  71    Tooling
  72    ExternalClangExamples
  73    IntroductionToTheClangAST
  74    LibTooling
  75    LibClang
  76    LibFormat
  77    ClangPlugins
  78    RAVFrontendAction
  79    LibASTMatchersTutorial
  80    LibASTMatchers
  81    ClangTransformerTutorial
  82    LibASTImporter
  83    HowToSetupToolingForLLVM
  84    JSONCompilationDatabase
  85    RefactoringEngine
  86
  87 Using Clang Tools
  88 =================
  89
  90 .. toctree::
  91    :maxdepth: 1
  92
  93    ClangTools
  94    ClangCheck
  95    ClangFormat
  96    ClangFormatStyleOptions
  97    ClangLinkerWrapper
  98    ClangNVLinkWrapper
  99    ClangOffloadBundler
 100    ClangOffloadPackager
 101    ClangRepl
 102    ClangSYCLLinker
 103
 104 Design Documents
 105 ================
 106
 107 .. toctree::
 108    :maxdepth: 1
 109
 110    Maintainers
 111    InternalsManual
 112    DriverInternals
 113    Multilib
 114    OffloadingDesign
 115    PCHInternals
 116    ItaniumMangleAbiTags
 117    HardwareAssistedAddressSanitizerDesign.rst
 118    ConstantInterpreter
 119
 120
 121 Indices and tables
 122 ==================
 123
 124 * :ref:`genindex`
 125 * :ref:`search`
 126