Return the options block of a generator.

Synopsis

Declared in <mrdocs/Generator.hpp>

dom::Object
getGeneratorParams(
    Generator const& generator,
    Config const& config);

Description

This is the generator‐options.<id> block of the configuration for the generator's Generator::id, or an empty object when the configuration has none. It is the one place that reads Config::generatorOptions for a generator: a generator class calls it from Generator::build, and the wrappers of callable and script generators fill GeneratorExtensionContext::params with it.

Return Value

The block, which shares its storage with the configuration.

Parameters

Name

Description

generator

The generator whose block is looked up.

config

The configuration to read the block from.

Created with MrDocs