View source code
Display the source code in dmd/lexer.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.

Function dmd.lexer.Lexer.getDocComment

Parse doc comment embedded between t.ptr and p. Remove trailing blanks and tabs from lines. Replace all newlines with \n. Remove leading comment character from each line. Decide if it's a lineComment or a blockComment. Append to previous one for this token.

final void getDocComment (
  Token* t,
  uint lineComment,
  bool newParagraph
);

If newParagraph is true, an extra newline will be added between adjoining doc comments.

Authors

Walter Bright

License

Boost License 1.0