ddmd.doc

Compiler implementation of the D programming language.

Members

Aliases

Sections
alias Sections = Array!(Section)
Undocumented in source.

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

emitComment
void emitComment(Dsymbol s, OutBuffer* buf, Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
emitMemberComments
void emitMemberComments(ScopeDsymbol sds, OutBuffer* buf, Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
emitProtection
void emitProtection(OutBuffer* buf, Prot prot)
Undocumented in source. Be warned that the author may not have intended to support it.
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.

icmp
int icmp(const(char)* stringz, const(void)* s, size_t slen)
Undocumented in source. Be warned that the author may not have intended to support it.
isCVariadicArg
bool isCVariadicArg(const(char)* p, size_t len)

Determine if p points to the start of a "..." parameter identifier.

isCVariadicParameter
bool isCVariadicParameter(Dsymbols* a, const(char)* p, size_t len)
Undocumented in source. Be warned that the author may not have intended to support it.
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.

toDocBuffer
void toDocBuffer(Dsymbol s, OutBuffer* buf, Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
utfStride
int utfStride(const(char)* p)

Return number of bytes in UTF character.

Static functions

emitAnchor
void emitAnchor(OutBuffer* buf, Dsymbol s, Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
emitAnchorName
bool emitAnchorName(OutBuffer* buf, Dsymbol s, Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.
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.

getEponymousMember
Dsymbol getEponymousMember(TemplateDeclaration td)
Undocumented in source. Be warned that the author may not have intended to support it.
getEponymousParent
TemplateDeclaration getEponymousParent(Dsymbol s)
Undocumented in source. Be warned that the author may not have intended to support it.
skipNonQualScopes
Scope* skipNonQualScopes(Scope* sc)
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

ddoc_decl_dd_e
const(char)* ddoc_decl_dd_e;
Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.
ddoc_decl_dd_s
const(char)* ddoc_decl_dd_s;
Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.
ddoc_decl_e
const(char)* ddoc_decl_e;
Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.
ddoc_decl_s
const(char)* ddoc_decl_s;
Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.
ddoc_default
const(char)* ddoc_default;
Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.

Structs

DocComment
struct DocComment
Escape
struct Escape
Undocumented in source.

Meta

Source

See Source File
$(DMDSRC _doc.d)