ddmd.doc

Compiler implementation of the D programming language.

Members

Classes

MacroSection class MacroSection
ParamSection class ParamSection
Section class Section

Functions

cmp int cmp(const(char)* stringz, const(void)* s, size_t slen): Compare 0-terminated string with length terminated string. Return < 0, ==0, > 0
escapeDdocString void escapeDdocString(OutBuffer* buf, size_t start): Having unmatched parentheses can hose the output of Ddoc, as the macros depend on properly nested parentheses. This function replaces all ( with ( and ) with ) to preserve text literally. This also means macros in the text won't be expanded.
escapeStrayParenthesis void escapeStrayParenthesis(Loc loc, OutBuffer* buf, size_t start): Having unmatched parentheses can hose the output of Ddoc, as the macros depend on properly nested parentheses.
gendocfile void gendocfile(Module m)
highlightCode void highlightCode(Scope* sc, Dsymbol s, OutBuffer* buf, size_t offset): Highlight code for DDOC section.
highlightCode void highlightCode(Scope* sc, Dsymbols* a, OutBuffer* buf, size_t offset)
highlightCode2 void highlightCode2(Scope* sc, Dsymbols* a, OutBuffer* buf, size_t offset): Highlight code for CODE section.
highlightCode3 void highlightCode3(Scope* sc, OutBuffer* buf, const(char)* p, const(char)* pend)
highlightText void highlightText(Scope* sc, Dsymbols* a, OutBuffer* buf, size_t offset): Highlight text section.
isCVariadicArg bool isCVariadicArg(const(char)* p, size_t len): Determine if p points to the start of a "..." parameter identifier.
isDitto bool isDitto(const(char)* comment): Return true if comment consists entirely of "ditto".
isFunctionParameter Parameter isFunctionParameter(Dsymbols* a, const(char)* p, size_t len)
isIdStart bool isIdStart(const(char)* p): Determine if p points to the start of an identifier.
isIdTail bool isIdTail(const(char)* p): Determine if p points to the rest of an identifier.
isIdentifier bool isIdentifier(Dsymbols* a, const(char)* p, size_t len)
isIndentWS bool isIndentWS(const(char)* p): Determine if p points to the indentation space.
isKeyword bool isKeyword(const(char)* p, size_t len)
isReservedName bool isReservedName(const(char)* str, size_t len): Return true if str is a reserved symbol name that starts with a double underscore.
isTemplateParameter TemplateParameter isTemplateParameter(Dsymbols* a, const(char)* p, size_t len)
isTypeFunction TypeFunction isTypeFunction(Dsymbol s)
skippastURL size_t skippastURL(OutBuffer* buf, size_t i): Scan forward past URL starting at i. We don't want to highlight parts of a URL.
skippastident size_t skippastident(OutBuffer* buf, size_t i): Scan forward past end of identifier.
skiptoident size_t skiptoident(OutBuffer* buf, size_t i): Scan forward to one of: start of identifier beginning of next line end of buf
skipwhitespace const(char)* skipwhitespace(const(char)* p): Skip white space.
utfStride int utfStride(const(char)* p): Return number of bytes in UTF character.

Static functions

expandTemplateMixinComments void expandTemplateMixinComments(TemplateMixin tm, OutBuffer* buf, Scope* sc): Recursively expand template mixin member docs into the scope.
getCodeIndent size_t getCodeIndent(const(char)* src): Get leading indentation from 'src' which represents lines of code.

Structs

DocComment struct DocComment
Escape struct Escape

ddmd.doc

Members

Classes

Functions

Static functions

Structs

Meta

Source

Authors

License

Copyright