mrdocs::makeGeneratorExtensionContext

Return the context a generator's callable or script receives.

Synopsis

Declared in <mrdocs/Extensions/GeneratorExtensionContext.hpp>

GeneratorExtensionContext
makeGeneratorExtensionContext(
    Generator const& generator,
    Corpus const& corpus,
    Config const& config,
    report::Reporter& reporter);

Description

Every field is filled from the arguments, with GeneratorExtensionContext::outputPath read by getGeneratorOutputPath and GeneratorExtensionContext::params by getGeneratorParams. It is the one place that builds a GeneratorExtensionContext, so the wrappers of callable and script generators hand over the same thing.

Return Value

The context, which points at the arguments.

Parameters

Name

Description

generator

The generator the context is for.

corpus

The symbols to emit.

config

The configuration that drove the build.

reporter

The reporter of the run.

Created with MrDocs