DocSymbol

A class that holds some info about a symbol.

class DocSymbol {

cstring name;

Location begin;

Location end;

DocSymbol[] members;

string[] attrs;

this(cstring name, cstring fqn, Kind kind, string[] attrs, Location begin, Location end);

string[] kindIDToStr;

uint[hash_t] kindStrToID;

uint[hash_t] attrToID;

cstring formatAttrsAsIDs();

}

Constructors

this this(cstring name, cstring fqn, Kind kind, string[] attrs, Location begin, Location end): Constructs a DocSymbol object.

Members

Enums

Kind enum Kind: Enum of symbol kinds.

Functions

formatAttrsAsIDs cstring formatAttrsAsIDs(): Return the attributes as IDs. E.g.: "[1,9,22]"

Static variables

attrToID uint[hash_t] attrToID;: Maps the attribute of a symbol to its ID. Must match the list in "kandil/js/symbols.js".
kindIDToStr string[] kindIDToStr;: Symbol kinds as strings.
kindStrToID uint[hash_t] kindStrToID;: Maps the kind of a symbol to its ID. Must match the list in "kandil/js/symbols.js".

Variables

attrs string[] attrs;: All attributes of this symbol.
end Location end;: Beginning and end locations.
fqn cstring fqn;: Name and fully qualified name.
kind Kind kind;: The kind of this symbol.
members DocSymbol[] members;: All symbol members.

Meta

Source

See Implementation

dil doc DDocEmitter classes