module diode.interfaces

Code Map

module diode.interfaces;


//! Main class driving everything.
class Driver
{
public:
	settings: Settings;


public:
	this(settings: Settings) { }
	fn addBuiltins();
	fn processDoc();
	fn setConfig(source: string, filename: string);
	fn addLayout(source: string, filename: string);
	fn addInclude(source: string, filename: string);
	fn addDoc(source: string, filename: string);
	fn addDocTemplate(source: string, filename: string);
	fn renderFile(source: string, filename: string, output: string);
	fn verbose(fmt: string);
	fn info(fmt: string);
	fn warning(fmt: string);
}

//! Holds settings for Diode.
class Settings
{
public:
	enum vdocDirDefault;
	enum outputDirDefault;
	enum layoutDirDefault;
	enum includeDirDefault;


public:
	sourceDir: string;
	vdocDir: string;
	outputDir: string;
	layoutDir: string;
	includeDir: string;
	urlFromCommandLine: bool;
	url: string;
	baseurlFromCommandLine: bool;
	baseurl: string;
	//! Temporary hack for guru untill we add vdoc cross-reference code.
	guruHackSuffix: string;


public:
	this() { }
	fn fillInDefaults() { }
	fn processPath(val: string, def: string) { }
}
class Driver

Main class driving everything.

class Settings

Holds settings for Diode.

guruHackSuffix: string

Temporary hack for guru untill we add vdoc cross-reference code.