SymbolDatabase

class SymbolDatabase {

string[] moduleNames;

string[] moduleFiles;

string[string] moduleNameToLink;

SymbolDataModule moduleData(string moduleName);

string crossReference(Writer writer, string[] scopeStack, string word);

auto symbolStack(S1 moduleStack, S2 symbolStack);

}

Constructors

this this(): Construct a symbol database.

Members

Functions

crossReference string crossReference(Writer writer, string[] scopeStack, string word): Get a link to documentation of symbol specified by word (if word is a symbol).
moduleData SymbolDataModule moduleData(string moduleName): Get module data for specified module.
symbolStack auto symbolStack(S1 moduleStack, S2 symbolStack): Get a range describing a symbol with specified name.

Variables

moduleFiles string[] moduleFiles;: File paths of modules to document.
moduleNameToLink string[string] moduleNameToLink;: moduleNameToLink["pkg.module"] gets link to module pkg.module
moduleNames string[] moduleNames;: Names of modules to document.

Meta

Source

See Implementation

symboldatabase classes

SymbolDatabase

enums

SymbolType

functions

gatherData

structs

SymbolDataModule