dmd.doc

Ddoc documentation generation.

Specification: Documentation Generator

Members

Functions

escapeDdocString
void escapeDdocString(OutBuffer buf, size_t 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.

gendocfile
void gendocfile(Module m, char[] ddoctext, char* datetime, ErrorSink eSink, OutBuffer outbuf)

Generate Ddoc text for Module m and append it to outbuf.

gendocfile
void gendocfile(Module m, char* ddoctext_ptr, size_t ddoctext_length, char* datetime, ErrorSink eSink, OutBuffer outbuf)

Generate Ddoc file for Module m.

Structs

DocComment
struct DocComment
Escape
struct Escape
Undocumented in source.

Meta