DDocCommand

The ddoc command.

class DDocCommand : Command {

cstring destDirPath;

cstring[] macroPaths;

cstring[] filePaths;

cstring modsTxtPath;

cstring outFileExtension;

Regex!char[] regexps;

bool includeUndocumented;

bool includePrivate;

bool writeReport;

bool useKandil;

bool writeXML;

bool writeHLFiles;

bool rawOutput;

CompilationContext context;

Diagnostics diag;

Diagnostics reportDiag;

Highlighter hl;

ModuleManager mm;

void run();

void writeSyntaxHighlightedFile(Module mod);

void writeDocumentationFile(Module mod, MacroTable mtable);

void writeModuleLists();

void copyKandilFiles();

static void writePackage(ref CharArray a, Package pckg, uint_t indent = 2);

static char[] symbolsToJSON(DocSymbol symbol, ref CharArray text);

static char[] symbolsToJSON(DocSymbol symbol, cstring indent = "\t");

static char[] loadMacroFile(cstring filePath, Diagnostics diag);

Diagnostics getReportDiag(cstring moduleName);

class ModuleData;

void writeDDocReport();

}

Members

Classes

ModuleData class ModuleData: Used for collecting data for the report.

Functions

copyKandilFiles void copyKandilFiles(): Creates sub-folders and copies kandil's files into them.
getReportDiag Diagnostics getReportDiag(cstring moduleName): Returns the reportDiag for moduleName if it is not filtered by the -rx=REGEXP option.
run void run(): Executes the doc generation command.
writeDDocReport void writeDDocReport(): Writes the DDoc report.
writeDocumentationFile void writeDocumentationFile(Module mod, MacroTable mtable): Writes the documentation for a module to the disk.
writeModuleLists void writeModuleLists(): Writes the list of processed modules to the disk. Also writes DEST/js/modules.js if kandil is used.
writeSyntaxHighlightedFile void writeSyntaxHighlightedFile(Module mod): Writes a syntax highlighted file for mod.

Static functions

loadMacroFile char[] loadMacroFile(cstring filePath, Diagnostics diag): Loads a macro file. Converts any Unicode encoding to UTF-8.
symbolsToJSON char[] symbolsToJSON(DocSymbol symbol, ref CharArray text): Converts the symbol tree into JSON.
symbolsToJSON char[] symbolsToJSON(DocSymbol symbol, cstring indent = "\t"): Converts the symbol tree into JSON.
writePackage void writePackage(ref CharArray a, Package pckg, uint_t indent = 2): Writes the sub-packages and sub-modules of a package to the disk.

Variables

context CompilationContext context;: Environment variables of the compilation.
destDirPath cstring destDirPath;: Destination directory.
diag Diagnostics diag;: Collects error messages.
filePaths cstring[] filePaths;: Module file paths.
hl Highlighter hl;: For highlighting source files or DDoc code sections.
includePrivate bool includePrivate;: Whether to include private symbols.
includeUndocumented bool includeUndocumented;: Whether to include undocumented symbols.
macroPaths cstring[] macroPaths;: Macro file paths.
mm ModuleManager mm;: For managing loaded modules and getting a sorted list of them.
modsTxtPath cstring modsTxtPath;: Write list of modules to this file if specified.
outFileExtension cstring outFileExtension;: The extension of the output files.
rawOutput bool rawOutput;: Whether to expand macros or not.
regexps Regex!char[] regexps;: Regular expressions.
reportDiag Diagnostics reportDiag;: Collects problem messages.
useKandil bool useKandil;: Whether to use kandil.
writeHLFiles bool writeHLFiles;: Whether to write syntax highlighted files.
writeReport bool writeReport;: Whether to write a problem report.
writeXML bool writeXML;: Whether to write XML instead of HTML docs.

Inherited Members

From Command

verbose bool verbose;: Verbose output.
log void log(cstring format, ...): Logs messages to stdout.
lzy void lzy(lazy void logfunc): Calls logfunc only when the verbose-flag is on.
run void run(): Runs the command.

Meta

Source

See Implementation

cmd DDoc modules