Packages

object Table extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Table
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait FieldName extends AnyRef
  2. sealed trait Format extends AnyRef

    Format is further used in Table which is used for config documentation.

    Format is further used in Table which is used for config documentation. Format helps the readers of the documentation understand the details of the format of each paths that forms their application config.

    Example: A format can be List, Map, Primitive, or it can even be even more complex such as AllOf or AnyOneOf. If Format of paths K is AllOf, it implies that there are more distinct paths under the paths K, and user need to satisfy (i.e, provide them in the source) all of the paths under K.

    If Format of paths K is AnyOneOf, it implies there are more distinct paths under the paths K, then user need to satisfy (i.e, provide them in the source) any one of the paths under K.

    If Format of oaths K is Recursion then that means there is a repetition of same path structure under the paths K

  3. sealed abstract case class Heading extends Product with Serializable
  4. sealed abstract case class Link extends Product with Serializable
  5. case class TableRow(paths: List[FieldName], format: Option[Format], description: List[Description], nested: Option[Table], sources: Set[String]) extends Product with Serializable

    A TableRow represents each row in a Table which is an intermediate light-weight structure produced from ConfigDocs.

    A TableRow represents each row in a Table which is an intermediate light-weight structure produced from ConfigDocs. Table is more easier to be converted to formats such as Json, markdown or any custom format fo your choice.

    paths

    : Each config key is basically a list of paths representing its hierarchy. Example: "aws.ec2.instance.type" where list of paths is List("aws", "ec2", "instance", "type")

    format

    : The format of value of key (paths). Example: it can be a Primitive type (String, Int etc), or it can be complex structures as such as List or Map.

    description

    : Description (zio-config in-built or user-provided) of the key (paths).

    nested

    : A TableRow can be pointed to a nested table that has the details of all the child paths that are under paths. Hence TableRow is a recursive structure.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def confluenceFlavoured(baseLink: Option[String])(implicit S: <:<[ConfigDocsModule.K, String]): (Heading, Int, Either[FieldName, Format]) ⇒ Link
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def githubFlavoured(implicit S: <:<[ConfigDocsModule.K, String]): (Heading, Int, Either[FieldName, Format]) ⇒ Link

    Internal function that represents the creation of a github flavoured markdown.

    Internal function that represents the creation of a github flavoured markdown. The implementation can be used as reference for users who would like to produce a different style markdown rendering by specifying how to create Link given a Heading, Int representing the index of the key (or paths) and Either[FieldName, Format].

    The index exists because it represents the index of a heading (which is the individual key of paths) in markdown. This is usually zero for all headings unless there are duplicate headings in the markdown. There is a possibility of duplicate headings in the markdown, if for instance, given a path x.y and k.y, the heading y can appear twice in the markdown file with indices as 0 and 1. Depending on the flavour of markdown (Example: Github, Confluence) we have different ways to produce links towards those headings. In this case, we employ the strategy used by Github.

  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def singletonTable(tableRow: TableRow): Table
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. object FieldName
  24. object Format
  25. object Heading extends Serializable
  26. object Link extends Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped