ddoc

Undocumented in source.

Members

Aliases

unsigned
alias unsigned = uint

Given buffer p[0..end], extract argument marg[0..marglen].

Functions

escapeDdocString
void escapeDdocString(OutBuffer* buf, unsigned 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(OutBuffer* buf, unsigned start)

Having unmatched parentheses can hose the output of Ddoc, as the macros depend on properly nested parentheses.

isIdStart
int isIdStart(char* p)

Determine if p points to the start of an identifier.

isIdTail
int isIdTail(char* p)

Determine if p points to the rest of an identifier.

isKeyword
int isKeyword(char* p, unsigned len)
parseEscapes
void parseEscapes(Escape** pescapetable, char* textstart, unsigned textlen)

Parse escapes of the form: /c/string/ where c is a single character. Multiple escapes can be separated by whitespace and/or commas.

parseMacros
void parseMacros(Escape** pescapetable, Macro** pmacrotable, char* m, unsigned mlen)

Parse macros out of Macros: section. Macros are of the form: name1 = value1

parseSections
Section*[] parseSections(char* comment)

Parse next paragraph out of *pcomment. Update *pcomment to point past paragraph. Returns null if no more paragraphs. If paragraph ends in 'identifier:', then (*pcomment)[0 .. idlen] is the identifier.

utfStride
int utfStride(char* p)

Return number of bytes in UTF character.

Structs

Macro
struct Macro
Undocumented in source.
Suggestion Box / Bug Report