GendocConfig

Gendoc's configuration data structure

struct GendocConfig {

string[] ddocs;

string[] sourceDocs;

string target;

string[] excludePaths;

string[] excludePatterns;

string[] excludePackages;

string[][string] combinedDubPackagePatterns;

string[] excludePackagePatterns;

bool enableGenerateJSON;

void fixPath(string dirPath);

bool loadConfig(string path);

bool loadDefaultConfig(string root);

void setup(string root, string configFile, string[] optDdocs, string[] optSourceDocs, string optTarget);

}

Members

Functions

fixPath void fixPath(string dirPath)
loadConfig bool loadConfig(string path)
loadDefaultConfig bool loadDefaultConfig(string root): Load configuration from specifiered path
setup void setup(string root, string configFile, string[] optDdocs, string[] optSourceDocs, string optTarget)

Variables

combinedDubPackagePatterns string[][string] combinedDubPackagePatterns;: {"keyName": ["dub_package_name_regex_pattern1", "dub_package_name_regex_pattern2"]}
ddocs string[] ddocs;
enableGenerateJSON bool enableGenerateJSON;
excludePackagePatterns string[] excludePackagePatterns;
excludePackages string[] excludePackages;
excludePaths string[] excludePaths;
excludePatterns string[] excludePatterns;
sourceDocs string[] sourceDocs;
target string target;

Meta

Source

See Implementation

gendoc config structs