clang::doc::Generator Class Reference

#include <Generators.h>

Inheritance diagram for clang::doc::Generator:

Public Member Functions
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 Member Functions
static void	addInfoToIndex (Index &Idx, const doc::Info *Info)

Detailed Description

Definition at line 24 of file Generators.h.

Constructor & Destructor Documentation

~Generator()

virtual clang::doc::Generator::~Generator ( )

virtualdefault

Member Function Documentation

addInfoToIndex()

void clang::doc::Generator::addInfoToIndex ( Index & Idx, const doc::Info * Info )

static

Definition at line 59 of file Generators.cpp.

References clang::doc::Index::Children, clang::doc::Info::extractName(), clang::doc::Info::IT, clang::doc::Info::Namespace, clang::doc::Info::Path, and clang::doc::Info::USR.

createResources()

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

virtual

Reimplemented in clang::doc::HTMLGenerator, clang::doc::JSONGenerator, clang::doc::MDGenerator, and clang::doc::MustacheHTMLGenerator.

Definition at line 45 of file Generators.cpp.

generateDocForInfo()

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

pure virtual

Implemented in clang::doc::HTMLGenerator, clang::doc::JSONGenerator, clang::doc::MDGenerator, and clang::doc::YAMLGenerator.

generateDocs()

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

pure virtual

Implemented in clang::doc::HTMLGenerator, clang::doc::JSONGenerator, clang::doc::MDGenerator, and clang::doc::YAMLGenerator.

---

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

• Generators.h
• Generators.cpp