ddox.ddoc

DietDoc/DDOC support routines

Members

DdocComment class DdocComment: Holds a DDOC comment and formats it sectionwise as HTML.

enableHyphenation void enableHyphenation(): Enable hyphenation of doc text.
filterDdocComment void filterDdocComment(R dst, string text, DdocContext context, int hlevel, bool delegate(string) display_section): Takes a DDOC string and outputs formatted HTML.
formatDdocComment string formatDdocComment(string ddoc_, int hlevel, bool delegate(string) display_section)
string formatDdocComment(string text, DdocContext context, int hlevel, bool delegate(string) display_section): Takes a DDOC string and outputs formatted HTML.
hyphenate void hyphenate(char[] word, R orng): Undocumented in source. Be warned that the author may not have intended to support it.
setDefaultDdocMacroFiles void setDefaultDdocMacroFiles(string[] filenames): Sets a set of macros that will be available to all calls to formatDdocComment.
setOverrideDdocMacroFiles void setOverrideDdocMacroFiles(string[] filenames): Sets a set of macros that will be available to all calls to formatDdocComment and override local macro definitions.

DdocContext interface DdocContext: Provides context information about the documented element.

s_defaultMacros string[string] s_defaultMacros;: Undocumented in source.
s_overrideMacros string[string] s_overrideMacros;: Undocumented in source.