mrdocs::Generator

Base class for documentation generators.

Synopsis

Declared in <mrdocs/Generator.hpp>

class Generator;

Member Functions

Name

Description

~Generator [destructor] [virtual]

Destructor.

build [virtual]

Build the documentation for the corpus.

displayName [virtual]

Return the display name of the generator.

fileExtension [virtual]

Return the extension or tag of the generator.

id [virtual]

Return the symbolic name of the generator.

Non-Member Functions

Name

Description

findGenerator

Find a generator by its id.

Created with MrDocs