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    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    Modules
  44    MSVCCompatibility
  45    MisExpect
  46    OpenCLSupport
  47    OpenMPSupport
  48    SYCLSupport
  49    HLSL/HLSLDocs
  50    ThinLTO
  51    APINotes
  52    DebuggingCoroutines
  53    CommandGuide/index
  54    FAQ
  55
  56 Using Clang as a Library
  57 ========================
  58
  59 .. toctree::
  60    :maxdepth: 1
  61
  62    Tooling
  63    ExternalClangExamples
  64    IntroductionToTheClangAST
  65    LibTooling
  66    LibFormat
  67    ClangPlugins
  68    RAVFrontendAction
  69    LibASTMatchersTutorial
  70    LibASTMatchers
  71    ClangTransformerTutorial
  72    LibASTImporter
  73    HowToSetupToolingForLLVM
  74    JSONCompilationDatabase
  75    RefactoringEngine
  76
  77 Using Clang Tools
  78 =================
  79
  80 .. toctree::
  81    :maxdepth: 1
  82
  83    ClangTools
  84    ClangCheck
  85    ClangFormat
  86    ClangFormatStyleOptions
  87    ClangFormattedStatus
  88    ClangLinkerWrapper
  89    ClangNvlinkWrapper
  90    ClangOffloadBundler
  91    ClangOffloadWrapper
  92    ClangOffloadPackager
  93
  94 Design Documents
  95 ================
  96
  97 .. toctree::
  98    :maxdepth: 1
  99
 100    InternalsManual
 101    DriverInternals
 102    OffloadingDesign
 103    PCHInternals
 104    ItaniumMangleAbiTags
 105    HardwareAssistedAddressSanitizerDesign.rst
 106    ConstantInterpreter
 107
 108
 109 Indices and tables
 110 ==================
 111
 112 * :ref:`genindex`
 113 * :ref:`modindex`
 114 * :ref:`search`
 115