AvroDoc

vulcan.generic.AvroDoc

final class AvroDoc(val doc: String) extends StaticAnnotation

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 using Codec.derive from the generic module.
Annotate a case class parameter for record field documentation when using Codec.derive from the generic module.

Attributes

Graph
Supertypes: trait StaticAnnotation

class Annotation

class Object

trait Matchable

class Any

Returns a string representation of the object.

The default representation is platform dependent.

In this article

Generated with