AvroDoc
Annotation which can be used to include documentation in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum documentation when using
deriveEnum.
- Annotate a type for fixed documentation when using
deriveFixed.
- Annotate a
case class
for record documentation when usingCodec.derive
from the generic module. - Annotate a
case class
parameter for record field documentation when usingCodec.derive
from the generic module.
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any