diff options
Diffstat (limited to 'src/dotty/tools/dotc/util/CommentParsing.scala')
| -rw-r--r-- | src/dotty/tools/dotc/util/CommentParsing.scala | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/dotty/tools/dotc/util/CommentParsing.scala b/src/dotty/tools/dotc/util/CommentParsing.scala index 077776b5d..cc790d683 100644 --- a/src/dotty/tools/dotc/util/CommentParsing.scala +++ b/src/dotty/tools/dotc/util/CommentParsing.scala @@ -5,6 +5,13 @@ */ package dotty.tools.dotc.util +/** The comment parsing in `dotc` is used by both the comment cooking and the + * dottydoc tool. + * + * The comment cooking is used to expand comments with `@inheritdoc` and + * `@define` annotations. The rest of the comment is untouched and later + * handled by dottydoc. + */ object CommentParsing { import scala.reflect.internal.Chars._ |