mrdocs::Generator::build

Build reference documentation for the corpus.

Synopses

Declared in <mrdocs/Generator.hpp>

Build reference documentation for the corpus.

Expected<void>
build(Corpus const& corpus) const;

Build reference documentation for the corpus.

virtual
Expected<void>
build(
    std::string_view outputPath,
    Corpus const& corpus) const;

Return Value

The error, if any occurred.

Parameters

Name Description

corpus

The symbols to emit. The generator may modify the contents of the object before returning.

outputPath

A directory or filename.

Created with MrDocs