clang-tools  15.0.0git
Public Member Functions | Static Public Member Functions | List of all members
clang::doc::Generator Class Referenceabstract

#include <Generators.h>

Inheritance diagram for clang::doc::Generator:
Inheritance graph
[legend]

Public Member Functions

virtual ~Generator ()=default
 
virtual llvm::Error generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx)=0
 
virtual llvm::Error createResources (ClangDocContext &CDCtx)
 

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

◆ createResources()

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

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

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

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