Build the documentation for the corpus.

Synopsis

Declared in <mrdocs/Generator.hpp>

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

Description

The generator reads its configuration from the config passed in (a corpus does not own its configuration), 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

Name

Description

corpus

The symbols to emit.

config

The configuration that drove the build.

Created with MrDocs