diff options
Diffstat (limited to 'shared/src/main/scala/annotations.scala')
| -rw-r--r-- | shared/src/main/scala/annotations.scala | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/shared/src/main/scala/annotations.scala b/shared/src/main/scala/annotations.scala index 1b7c62c..4437aeb 100644 --- a/shared/src/main/scala/annotations.scala +++ b/shared/src/main/scala/annotations.scala @@ -2,11 +2,11 @@ package spray.json import scala.annotation.StaticAnnotation -/** An annotation that designates that a sealed trait is a generalized algebraic - * datatype (GADT), and that a field containing the serialized childrens' types - * should be added to the final JSON objects. +/** An annotation that designates that a sealed trait is an algebraic datatype + * (ADT), and that a field containing the serialized childrens' types should be + * added to the final JSON objects. * - * Note that by default all sealed traits are treated as GADTs, with a type + * Note that by default all sealed traits are treated as ADTs, with a type * field called `type`. This annotation enables overriding the name of that * field and is really only useful if a child itself has a field called `type` * that would otherwise result in a conflict. @@ -14,9 +14,9 @@ import scala.annotation.StaticAnnotation * Example: * {{{ * // the JSON field "kind" will contain the actual type of the serialized child - * @gadt("kind") sealed abstract class Keyword(`type`: String) + * @adt("kind") sealed abstract class Keyword(`type`: String) * case class If(`type`: String) extends Keyword(`type`) * }}} * @param typeFieldName the name of the field to inject into a serialized JSON * object */ -final class gadt(val typeFieldName: String = "type") extends StaticAnnotation +final class adt(val typeFieldName: String = "type") extends StaticAnnotation |