View source code
Display the source code in dmd/doc.d from which thispage was generated on github.
Report a bug
If you spot a problem with this page, click here to create aBugzilla 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 usinglocal clone.

Struct dmd.doc.DocComment

struct DocComment;

Methods

NameDescription
parseEscapes (escapetable, 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 (escapetable, pmacrotable, m) Parse macros out of Macros: section. Macros are of the form: name1 = value1
parseSections (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.

Authors

Walter Bright

License

Boost License 1.0