clang::doc::JSONGenerator Class Reference

Inheritance diagram for clang::doc::JSONGenerator:

Public Member Functions
Error	generateDocs (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx) 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

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 11 of file JSONGenerator.cpp.

Member Function Documentation

createResources()

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

overridevirtual

Reimplemented from clang::doc::Generator.

Definition at line 658 of file JSONGenerator.cpp.

generateDocForInfo()

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

overridevirtual

Implements clang::doc::Generator.

Definition at line 633 of file JSONGenerator.cpp.

References 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, clang::doc::IT_variable, clang::doc::ClangDocContext::RepositoryUrl, and clang::doc::serializeInfo().

Referenced by generateDocs().

generateDocs()

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

overridevirtual

Implements clang::doc::Generator.

Definition at line 592 of file JSONGenerator.cpp.

References clang::doc::determineFileName(), clang::doc::Info::DocumentationFileName, generateDocForInfo(), and clang::doc::Info::getRelativeFilePath().

Referenced by clang::doc::MustacheHTMLGenerator::generateDocs().

Member Data Documentation

Format

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

static

Definition at line 13 of file JSONGenerator.cpp.

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

---

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

• JSONGenerator.cpp