DocComment

struct DocComment {

Sections sections;

Section summary;

Section copyright;

Section macros;

MacroTable* pmacrotable;

Escape* escapetable;

static DocComment* parse(Dsymbol s, const(char)* comment);

static void parseMacros(Escape* escapetable, MacroTable pmacrotable, const(char)[] m);

static void parseEscapes(Escape* escapetable, const(char)[] text);

void parseSections(const(char)* comment);

void writeSections(Scope* sc, Dsymbols* a, OutBuffer* buf);

}

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.
writeSections void writeSections(Scope* sc, Dsymbols* a, OutBuffer* buf): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

parse DocComment* parse(Dsymbol s, const(char)* comment): Undocumented in source. Be warned that the author may not have intended to support it.
parseEscapes void parseEscapes(Escape* escapetable, const(char)[] text): 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, MacroTable pmacrotable, const(char)[] m): Parse macros out of Macros: section. Macros are of the form: name1 = value1

Variables

a Dsymbols a;: Undocumented in source.
copyright Section copyright;: Undocumented in source.
escapetable Escape* escapetable;: Undocumented in source.
macros Section macros;: Undocumented in source.
pmacrotable MacroTable* pmacrotable;: Undocumented in source.
sections Sections sections;: Undocumented in source.
summary Section summary;: Undocumented in source.

Meta

Source

See Implementation

dmd doc functions

structs