Build the documentation for the corpus.
Declared in <mrdocs/Generator.hpp>
virtual
Expected<void>
build(
Corpus const& corpus,
Config const& config,
report::Reporter& reporter) const = 0;
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.
Different corpus object: may be called concurrently.
Same corpus object: may not be called concurrently.
The error, if any occurred.
| Name | Description |
|---|---|
| corpus | The symbols to emit. |
| config | The configuration that drove the build. |
| reporter | The reporter of the run. |