mrdocs::Config::load_file

load_file overloads

Synopses

Declared in <mrdocs/Config.hpp>

Load the configuration options from a YAML file.

static
Expected<void>
load_file(
    Config& c,
    std::string_view configPath);

» more...

Load a config file, apply command‐line overrides, and finalize it.

static
Expected<void>
load_file(
    Config& c,
    std::string_view configPath,
    ReferenceDirectories const& dirs);

» more...

Load a config file, apply command‐line overrides, and finalize it.

static
Expected<void>
load_file(
    Config& c,
    std::string_view configPath,
    ReferenceDirectories const& dirs,
    char const** argv);

» more...

Return Value

Nothing on success, otherwise an error.

Parameters

Name

Description

c

The configuration to populate.

configPath

The path to the configuration file.

dirs

The reference directories used to resolve relative paths.

argv

The command line whose ‐‐option values override the file.

Created with MrDocs