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;
Undocumented in source.
doGenerateCSSPath
string doGenerateCSSPath;
Undocumented in source.
doGenerateConfig
bool doGenerateConfig;
Undocumented in source.
doGenerateConfigForLinux
bool doGenerateConfigForLinux;
Undocumented in source.
doHelp
bool doHelp;
Undocumented in source.
excludes
string[] excludes;

Names of packages and modules to exclude from generated documentation.

format
string format;
Undocumented in source.
indexFileName
string indexFileName;
Undocumented in source.
macroFileNames
string[] macroFileNames;
Undocumented in source.
macros
string[string] macros;

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

maxFileSizeK
uint maxFileSizeK;
Undocumented in source.
maxModuleListLength
uint maxModuleListLength;
Undocumented in source.
noMarkdown
bool noMarkdown;
Undocumented in source.
outputDirectory
string outputDirectory;
Undocumented in source.
performance
bool performance;
Undocumented in source.
projectName
string projectName;
Undocumented in source.
projectVersion
string projectVersion;
Undocumented in source.
showVersion
bool showVersion;
Undocumented in source.
sourcePaths
string[] sourcePaths;
Undocumented in source.
tocAdditionalFileNames
string[] tocAdditionalFileNames;
Undocumented in source.
tocAdditionalStrings
string[] tocAdditionalStrings;
Undocumented in source.

Meta