View source code
Display the source code in dmd/doc.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Module dmd.doc

Ddoc documentation generation.

Specification

Documentation Generator

Documentation

https://dlang.org/phobos/dmd_doc.html

Coverage

https://codecov.io/gh/dlang/dmd/src/master/src/dmd/doc.d

Functions

NameDescription
escapeDdocString(buf, 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(m, ddoctext_ptr, ddoctext_length, datetime, eSink, outbuf) Generate Ddoc file for Module m.
gendocfile(m, ddoctext, datetime, eSink, outbuf) Generate Ddoc text for Module m and append it to outbuf.

Structs

NameDescription
DocComment

Authors

Walter Bright

License

Boost License 1.0