Config

Stores configuration data loaded from command-line or config files.

Note that multiple calls to loadCLI/loadConfigFile are supported; data loaded with earlier calls is overwritten by later calls (e.g. command-line overriding config file), except arrays like macroFileNames/excludes/sourcePaths: successive calls always add to these arrays instead of overwriting them, so e.g. extra modules can be excluded with command-line.

Members

Functions

loadCLI
void loadCLI(string[] cliArgs)

Load config options from CLI arguments.

loadConfigFile
void loadConfigFile(string fileName, bool requestedByUser)

Load specified config file and add loaded data to the configuration.

Variables

cssFileName
string cssFileName;
doGenerateCSSPath
string doGenerateCSSPath;
doGenerateConfig
bool doGenerateConfig;
doHelp
bool doHelp;
excludes
string[] excludes;
format
string format;
indexFileName
string indexFileName;
macroFileNames
string[] macroFileNames;
macros
string[string] macros;

Loaded from macroFileNames + default macros; not set on the command-line.

maxFileSizeK
uint maxFileSizeK;
maxModuleListLength
uint maxModuleListLength;
noMarkdown
bool noMarkdown;
outputDirectory
string outputDirectory;
projectName
string projectName;
projectVersion
string projectVersion;
sourcePaths
string[] sourcePaths;
tocAdditionalFileNames
string[] tocAdditionalFileNames;
tocAdditionalStrings
string[] tocAdditionalStrings;

Meta