DocComment

struct DocComment {

Sections sections;

Section summary;

Section copyright;

Section macros;

MacroTable* pmacrotable;

Escape* escapetable;

Dsymbols a;

static void parseMacros(Escape* escapetable, ref MacroTable pmacrotable, const(char)* m, size_t mlen);

static void parseEscapes(Escape* escapetable, const(char)* textstart, size_t textlen);

void parseSections(const(char)* comment);

}

Members

Functions

parseSections void parseSections(const(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.

Static functions

parseEscapes void parseEscapes(Escape* escapetable, const(char)* textstart, size_t 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* escapetable, ref MacroTable pmacrotable, const(char)* m, size_t mlen): Parse macros out of Macros: section. Macros are of the form: name1 = value1

Meta

Source

See Implementation

dmd doc functions

structs