DdocComment

Holds a DDOC comment and formats it sectionwise as HTML.

class DdocComment {

this(string text);

bool isDitto [@property getter];

bool isPrivate [@property getter];

const(string[string]) macros [@property getter];

bool hasSection(string name);

void renderSectionR(R dst, DdocContext context, string name, int hlevel);

void renderSectionsR(R dst, DdocContext context, bool delegate(string) display_section, int hlevel);

string renderSection(DdocContext context, string name, int hlevel);

string renderSections(DdocContext context, bool delegate(string) display_section, int hlevel);

}

Constructors

this this(string text): Undocumented in source.

Members

Functions

hasSection bool hasSection(string name): Undocumented in source. Be warned that the author may not have intended to support it.
renderSection string renderSection(DdocContext context, string name, int hlevel): Undocumented in source. Be warned that the author may not have intended to support it.
renderSectionR void renderSectionR(R dst, DdocContext context, string name, int hlevel): Undocumented in source. Be warned that the author may not have intended to support it.
renderSections string renderSections(DdocContext context, bool delegate(string) display_section, int hlevel): Undocumented in source. Be warned that the author may not have intended to support it.
renderSectionsR void renderSectionsR(R dst, DdocContext context, bool delegate(string) display_section, int hlevel): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

isDitto bool isDitto [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
isPrivate bool isPrivate [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
macros const(string[string]) macros [@property getter]: The macros contained in the "Macros" section (if any)

Meta

Source

See Implementation

ddox ddoc classes

DdocComment

enums

DdocRenderOptions

functions

interfaces

DdocContext

structs

HTMLTagStream