mrdocs::Generator::build

Build the documentation for the corpus.

Synopsis

Declared in <mrdocs/Generator.hpp>

virtual
Expected<void>
build(
    Corpus const& corpus,
    Config const& config,
    report::Reporter& reporter) const = 0;

Description

A generator reports through reporter, the reporter of the session that runs it.

The generator reads its configuration from the config passed in (a corpus does not own its configuration) and its own options with getGeneratorParams, resolves its own output location, and writes whatever files it needs.

Thread Safety

  • Different corpus object: may be called concurrently.

  • Same corpus object: may not be called concurrently.

Return Value

The error, if any occurred.

Parameters

NameDescription
corpusThe symbols to emit.
configThe configuration that drove the build.
reporterThe reporter of the run.