Display the source code in dmd/doc.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

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`

Compiler implementation of the D programming language.

Documentation

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

Coverage

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

Functions

Name	Description
`cmp(stringz, s, slen)`	Compare 0-terminated string with length terminated string. Return < 0, ==0, > 0
`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.
`escapeStrayParenthesis(loc, buf, start)`	Having unmatched parentheses can hose the output of Ddoc, as the macros depend on properly nested parentheses.
`gendocfile(m)`
`highlightCode(sc, s, buf, offset)`	Highlight code for DDOC section.
`highlightCode(sc, a, buf, offset)`
`highlightCode2(sc, a, buf, offset)`	Highlight code for CODE section.
`highlightCode3(sc, buf, p, pend)`
`highlightText(sc, a, buf, offset)`	Highlight text section.
`isCVariadicArg(p, len)`	Determine if p points to the start of a "..." parameter identifier.
`isDitto(comment)`	Return true if comment consists entirely of "ditto".
`isFunctionParameter(a, p, len)`
`isIdentifier(a, p, len)`
`isIdStart(p)`	Determine if p points to the start of an identifier.
`isIdTail(p)`	Determine if p points to the rest of an identifier.
`isIndentWS(p)`	Determine if p points to the indentation space.
`isKeyword(p, len)`
`isReservedName(str, len)`	Return true if str is a reserved symbol name that starts with a double underscore.
`isTemplateParameter(a, p, len)`
`isTypeFunction(s)`
`skippastident(buf, i)`	Scan forward past end of identifier.
`skippastURL(buf, i)`	Scan forward past URL starting at i. We don't want to highlight parts of a URL.
`skiptoident(buf, i)`	Scan forward to one of: start of identifier beginning of next line end of buf
`skipwhitespace(p)`	Skip white space.
`utfStride(p)`	Return number of bytes in UTF character.

Classes

Name	Description
`MacroSection`
`ParamSection`
`Section`

Structs

Name	Description
`DocComment`

Authors

Walter Bright

License

Boost License 1.0