Class/Object

zio.config.ConfigDocsModule

Table

Related Docs: object Table | package ConfigDocsModule

Permalink

sealed case class Table(rows: List[TableRow]) extends Product with Serializable

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.

Self Type
Table
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Table
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Table(rows: List[TableRow])

    Permalink

Type Members

  1. type Index = Int

    Permalink

  2. type Size = Int

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def ++(that: Table): Table

    Permalink

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. def mapFormat(f: (Option[Format]) ⇒ Format): Table

    Permalink

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. val rows: List[TableRow]

    Permalink

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toConfluenceMarkdown(baseUrl: Option[String])(implicit S: <:<[ConfigDocsModule.K, String]): String

    Permalink

    Create a Confluence flavored markdown string from Table.

    Create a Confluence flavored markdown string from Table. This can be used if you are planning to render this markdown in Atlassian's Confluence pages.

  18. def toGithubFlavouredMarkdown(implicit S: <:<[ConfigDocsModule.K, String]): String

    Permalink

    Create a Github flavored markdown string from Table.

    Create a Github flavored markdown string from Table. This can be used to render markdowns in Github, Gitlab etc

  19. def toMarkdown(getLink: (Heading, Int, Either[FieldName, Format]) ⇒ Link)(implicit S: <:<[ConfigDocsModule.K, String]): String

    Permalink

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. def withFormat(format: Format): Table

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped