mrdocs::Generator::buildOne

buildOne overloads

Synopses

Declared in <mrdocs/Generator.hpp>

Build the reference as a single page to a file.

Expected<void>
buildOne(
    std::string_view fileName,
    Corpus const& corpus) const;

» more...

Build reference documentation for the corpus.

virtual
Expected<void>
buildOne(
    std::ostream& os,
    Corpus const& corpus) const = 0;

» more...

Return Value

The error, if any occurred.

Parameters

Name Description

fileName

The file to write. If the file already exists, it will be overwritten.

corpus

The metadata to emit.

os

The stream to write to.

Created with MrDocs