aboutsummaryrefslogtreecommitdiff
path: root/src/dotty/tools/dotc/util/CommentParsing.scala
diff options
context:
space:
mode:
authorFelix Mulder <felix.mulder@gmail.com>2016-09-21 15:02:30 +0200
committerFelix Mulder <felix.mulder@gmail.com>2016-10-06 17:45:39 +0200
commit92536168e9fda4005a8eff54e5ca72cc70fb32e4 (patch)
tree285d92137cc5c33a0dba3b352b6fa252ed57ce13 /src/dotty/tools/dotc/util/CommentParsing.scala
parent208232aba52903ae090711589e9c572dc5347651 (diff)
downloaddotty-92536168e9fda4005a8eff54e5ca72cc70fb32e4.tar.gz
dotty-92536168e9fda4005a8eff54e5ca72cc70fb32e4.tar.bz2
dotty-92536168e9fda4005a8eff54e5ca72cc70fb32e4.zip
Separate `ContextDocstrings` from `Context` and make it pluggable
Diffstat (limited to 'src/dotty/tools/dotc/util/CommentParsing.scala')
-rw-r--r--src/dotty/tools/dotc/util/CommentParsing.scala7
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._