clang::doc::JSONGenerator Class Reference

Inheritance diagram for clang::doc::JSONGenerator:

Public Member Functions
Error	generateDocumentation (StringRef RootDir, llvm::StringMap< OwnedPtr< doc::Info > > Infos, const ClangDocContext &CDCtx, std::string DirName) override
Error	createResources (ClangDocContext &CDCtx) override
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	generateDocumentation (StringRef RootDir, llvm::StringMap< doc::OwnedPtr< doc::Info > > Infos, const ClangDocContext &CDCtx, std::string DirName="")=0

Public Attributes
const ClangDocContext *	CDCtx
bool	Markdown

Static Public Attributes
static const char *	Format = "json"

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

Detailed Description

Definition at line 23 of file JSONGenerator.cpp.

Member Function Documentation

createResources()

Error clang::doc::JSONGenerator::createResources ( ClangDocContext & CDCtx )

overridevirtual

Reimplemented from clang::doc::Generator.

Definition at line 999 of file JSONGenerator.cpp.

References CDCtx.

generateDocForInfo()

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

overridevirtual

Implements clang::doc::Generator.

Definition at line 974 of file JSONGenerator.cpp.

References CDCtx, clang::doc::Info::IT, clang::doc::IT_concept, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_friend, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, clang::doc::IT_typedef, and clang::doc::IT_variable.

Referenced by generateDocumentation().

generateDocumentation()

Error clang::doc::JSONGenerator::generateDocumentation ( StringRef RootDir, llvm::StringMap< OwnedPtr< doc::Info > > Infos, const ClangDocContext & CDCtx, std::string DirName )

override

Definition at line 923 of file JSONGenerator.cpp.

References CDCtx, clang::doc::Info::DocumentationFileName, generateDocForInfo(), clang::doc::getPtr(), clang::doc::Info::getRelativeFilePath(), clang::doc::Info::IT, clang::doc::IT_namespace, clang::doc::IT_record, Markdown, clang::doc::md_mustache, and clang::doc::serializeContexts().

Referenced by clang::doc::MustacheGenerator::generateDocumentation().

Member Data Documentation

CDCtx

const ClangDocContext* clang::doc::JSONGenerator::CDCtx

Definition at line 65 of file JSONGenerator.cpp.

Referenced by createResources(), generateDocForInfo(), and generateDocumentation().

Format

const char * clang::doc::JSONGenerator::Format = "json"

static

Definition at line 64 of file JSONGenerator.cpp.

Referenced by clang::doc::JSON().

Markdown

bool clang::doc::JSONGenerator::Markdown

Definition at line 66 of file JSONGenerator.cpp.

Referenced by generateDocumentation().

---

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

• JSONGenerator.cpp