clang::doc::MDGenerator Class Reference

Generator for Markdown documentation. More...

Inheritance diagram for clang::doc::MDGenerator:

Public Member Functions
llvm::Error	generateDocs (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx) override
llvm::Error	createResources (ClangDocContext &CDCtx) override
llvm::Error	generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx) override
Public Member Functions inherited from clang::doc::Generator
virtual	~Generator ()=default
virtual llvm::Error	generateDocs (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx)=0
virtual llvm::Error	createResources (ClangDocContext &CDCtx)
virtual llvm::Error	generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx)=0

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 365 of file MDGenerator.cpp.

Member Function Documentation

createResources()

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

overridevirtual

Reimplemented from clang::doc::Generator.

Definition at line 451 of file MDGenerator.cpp.

References clang::doc::genIndex(), and clang::doc::serializeIndex().

generateDocForInfo()

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

overridevirtual

Implements clang::doc::Generator.

Definition at line 426 of file MDGenerator.cpp.

References clang::doc::genMarkdown(), clang::doc::Info::IT, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, clang::doc::IT_typedef, and OS.

Referenced by generateDocs().

generateDocs()

llvm::Error clang::doc::MDGenerator::generateDocs ( StringRef  RootDir, llvm::StringMap< std::unique_ptr< doc::Info > >  Infos, const ClangDocContext &  CDCtx  )

overridevirtual

Implements clang::doc::Generator.

Definition at line 380 of file MDGenerator.cpp.

References generateDocForInfo(), clang::doc::Info::getFileBaseName(), clang::doc::Info::getRelativeFilePath(), and Path.

Member Data Documentation

Format

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

static

Definition at line 367 of file MDGenerator.cpp.

---

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

• MDGenerator.cpp