docs
API
Generated with
docs/zio.config/ConfigDocsModule

ConfigDocsModule

zio.config.ConfigDocsModule
trait ConfigDocsModule

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

sealed trait ConfigDocs

ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.

ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed case class Table(rows: List[TableRow])

A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert ConfigDocs to a readable format.

A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert ConfigDocs to a readable format.

Value parameters

rows:

A table consist of multiple TableRows where each TableRow holds the information about the config path.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Table

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Table.type

Value members

Concrete methods

final def generateDocs[A](config: Config[A]): ConfigDocs

Generate documentation based on the Config, where a Config is a structure representing the logic to fetch the application config from various sources.

Generate documentation based on the Config, where a Config is a structure representing the logic to fetch the application config from various sources.

Once we generate the docs, this can be converted to a light weight Table structure which is much more easier to be converted to markdown or json formats.

Example :

 val configDescriptor: Config[MyAppConfig] = ???

 generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown

Attributes

Generated with