Inheritance diagram for clang::doc::MustacheHTMLGenerator:

[legend]

Public Member Functions
Error	createResources (ClangDocContext &CDCtx) override
Error	generateDocForInfo (Info *I, raw_ostream &OS, const ClangDocContext &CDCtx) override
Error	setupTemplateFiles (const ClangDocContext &CDCtx) override
	Initializes the template files from disk and calls setupTemplate to register partials.
Error	generateDocForJSON (json::Value &JSON, raw_fd_ostream &OS, const ClangDocContext &CDCtx, StringRef ObjTypeStr, StringRef RelativeRootPath) override
Error	setupTemplateResources (const ClangDocContext &CDCtx, json::Value &V, SmallString< 128 > RelativeRootPath)
llvm::Error	generateDocumentation (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx, std::string DirName) override
	The main orchestrator for Mustache-based documentation.
Public Member Functions inherited from clang::doc::MustacheGenerator
Expected< std::string >	getInfoTypeStr (llvm::json::Object *Info, StringRef Filename)
SmallString< 128 >	getRelativePathToRoot (StringRef PathToFile, StringRef DocsRootPath)
	Used to find the relative path from the file to the format's docs root.
virtual	~MustacheGenerator ()=default
virtual llvm::Error	generateDocForJSON (llvm::json::Value &JSON, llvm::raw_fd_ostream &OS, const ClangDocContext &CDCtx, StringRef ObjectTypeStr, StringRef RelativeRootPath)=0
	Populates templates with data from JSON and calls any specifics for the format.
llvm::Error	setupTemplate (std::unique_ptr< MustacheTemplateFile > &Template, StringRef TemplatePath, std::vector< std::pair< StringRef, StringRef > > Partials)
	Registers partials to templates.
Public Member Functions inherited from clang::doc::Generator
virtual	~Generator ()=default
virtual llvm::Error	generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx)=0

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

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 32 of file HTMLMustacheGenerator.cpp.

Member Function Documentation

◆ createResources()

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

overridevirtual

Reimplemented from clang::doc::Generator.

Definition at line 150 of file HTMLMustacheGenerator.cpp.

References clang::doc::copyFile(), clang::doc::ClangDocContext::JsScripts, clang::doc::ClangDocContext::OutDirectory, and clang::doc::ClangDocContext::UserStylesheets.

◆ generateDocForInfo()

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

override

Definition at line 132 of file HTMLMustacheGenerator.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, and clang::doc::IT_variable.

◆ generateDocForJSON()

Error clang::doc::MustacheHTMLGenerator::generateDocForJSON	(	json::Value &	JSON,
		raw_fd_ostream &	OS,
		const ClangDocContext &	CDCtx,
		StringRef	ObjTypeStr,
		StringRef	RelativeRootPath )

override

Definition at line 113 of file HTMLMustacheGenerator.cpp.

References clang::doc::JSON(), clang::doc::NamespaceTemplate, clang::doc::RecordTemplate, and setupTemplateResources().

◆ generateDocumentation()

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

overridevirtual

The main orchestrator for Mustache-based documentation.

Initializes templates files from disk by calling setupTemplateFiles.
Calls the JSON generator to write JSON to disk.
Iterates over the JSON files, recreates the directory structure from JSON, and calls generateDocForJSON for each file.
A file of the desired format is created.

Reimplemented from clang::doc::MustacheGenerator.

Definition at line 161 of file HTMLMustacheGenerator.cpp.

References clang::doc::MustacheGenerator::generateDocumentation().