aboutsummaryrefslogtreecommitdiff
path: root/src/dotty/annotation/internal/Child.scala
diff options
context:
space:
mode:
authorMartin Odersky <odersky@gmail.com>2016-05-19 17:15:18 +0200
committerMartin Odersky <odersky@gmail.com>2016-05-19 17:15:18 +0200
commitc87c0303e40ef7e0103b2606c744bc7a2b61ece4 (patch)
tree7683eb3312ebcb34e7f9babffda1f2a62f2e6097 /src/dotty/annotation/internal/Child.scala
parentf1d95c286c802504b00b469bc924a39760fc9e73 (diff)
downloaddotty-c87c0303e40ef7e0103b2606c744bc7a2b61ece4.tar.gz
dotty-c87c0303e40ef7e0103b2606c744bc7a2b61ece4.tar.bz2
dotty-c87c0303e40ef7e0103b2606c744bc7a2b61ece4.zip
Better doc comment
Diffstat (limited to 'src/dotty/annotation/internal/Child.scala')
-rw-r--r--src/dotty/annotation/internal/Child.scala11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/dotty/annotation/internal/Child.scala b/src/dotty/annotation/internal/Child.scala
index 23ff2a97c..4f3ceb6c0 100644
--- a/src/dotty/annotation/internal/Child.scala
+++ b/src/dotty/annotation/internal/Child.scala
@@ -2,5 +2,14 @@ package dotty.annotation.internal
import scala.annotation.Annotation
-/** An annotation to indicate a child class or object of the annotated class. */
+/** An annotation to indicate a child class or object of the annotated class.
+ * E.g. if we have
+ *
+ * sealed class A
+ * case class B() extends A
+ * case class C() extends A
+ *
+ * Then `A` would carry the annotations `@Child[B] @Child[C]` where
+ * `B`, `C` are TypeRefs.
+ */
class Child[T] extends Annotation