Trait/Object

zio.cli

HelpDoc

Related Docs: object HelpDoc | package cli

Permalink

sealed trait HelpDoc extends AnyRef

A HelpDoc models the full documentation for a command-line application.

HelpDoc is composed of optional header and footers, and in-between, a list of HelpDoc-level content items.

HelpDoc-level content items, in turn, can be headers, paragraphs, description lists, and enumerations.

A HelpDoc can be converted into plaintext, JSON, and HTML.

Self Type
HelpDoc
Linear Supertypes
AnyRef, Any
Known Subclasses
DescriptionList, Empty, Enumeration, Header, Paragraph, Sequence
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HelpDoc
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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: HelpDoc): HelpDoc

    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 equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. def isDescriptionList: Boolean

    Permalink

  13. def isEmpty: Boolean

    Permalink

  14. def isEnumeration: Boolean

    Permalink

  15. def isHeader: Boolean

    Permalink

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. def isParagraph: Boolean

    Permalink

  18. def isSequence: Boolean

    Permalink

  19. def mapDescriptionList(f: (Span, HelpDoc) ⇒ (Span, HelpDoc)): HelpDoc

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  24. def toHTML: String

    Permalink

  25. def toPlaintext(columnWidth: Int = 100, color: Boolean = true): String

    Permalink

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

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

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

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

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

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

  30. def |(that: HelpDoc): HelpDoc

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped