clang-tools  15.0.0git
Public Member Functions | Static Public Attributes | List of all members
clang::doc::MDGenerator Class Reference

Generator for Markdown documentation. More...

Inheritance diagram for clang::doc::MDGenerator:
Inheritance graph
Collaboration diagram for clang::doc::MDGenerator:
Collaboration graph

Public Member Functions

llvm::Error generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx) override
llvm::Error createResources (ClangDocContext &CDCtx) override
- Public Member Functions inherited from clang::doc::Generator
virtual ~Generator ()=default

Static Public Attributes

static const char * Format = "md"

Additional Inherited Members

- Static Public Member Functions inherited from clang::doc::Generator
static void addInfoToIndex (Index &Idx, const doc::Info *Info)

Detailed Description

Generator for Markdown documentation.

Definition at line 352 of file MDGenerator.cpp.

Member Function Documentation

◆ createResources()

llvm::Error clang::doc::MDGenerator::createResources ( ClangDocContext CDCtx)

Reimplemented from clang::doc::Generator.

Definition at line 385 of file MDGenerator.cpp.

◆ generateDocForInfo()

llvm::Error clang::doc::MDGenerator::generateDocForInfo ( Info I,
llvm::raw_ostream &  OS,
const ClangDocContext CDCtx 

Implements clang::doc::Generator.

Definition at line 363 of file MDGenerator.cpp.

References clang::doc::genMarkdown(), clang::doc::Info::IT, and OS.

Member Data Documentation

◆ Format

const char * clang::doc::MDGenerator::Format = "md"

Definition at line 354 of file MDGenerator.cpp.

The documentation for this class was generated from the following file: