Generated with

microsite/izumi/izumi.distage/izumi.distage.config/izumi.distage.config.model/ConfigDoc

ConfigDoc

izumi.distage.config.model.ConfigDoc

final class ConfigDoc(val doc: String) extends DIStageAnnotation

Attaches a $comment field with the contents of the annotation to config's JSON Schema generated by ConfigWriter.

 @ConfigDoc("this is an example config")
 final case class ExampleConf(
  @ConfigDoc("this is an example field")
  intField: Int,
 )

Attributes

See also: izumi.distage.roles.bundled.ConfigWriter

izumi.distage.roles.bundled.JsonSchemaGenerator
Graph
Supertypes: trait DIStageAnnotation

trait TypeConstraint

trait StaticAnnotation

class Annotation

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete fields

In this article

Generated with