HelpDoc

zio.cli.HelpDoc
See theHelpDoc companion trait
object HelpDoc

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
HelpDoc.type

Members list

Type members

Classlikes

final case class DescriptionList(definitions: List[(Span, HelpDoc)]) extends HelpDoc

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
case object Empty extends HelpDoc

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
Self type
Empty.type
final case class Enumeration(elements: List[HelpDoc]) extends HelpDoc

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
Self type
final case class Header(value: Span, level: Int) extends HelpDoc

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
final case class Paragraph(value: Span) extends HelpDoc

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
final case class Sequence(left: HelpDoc, right: HelpDoc) extends HelpDoc

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait HelpDoc
class Object
trait Matchable
class Any
Show all
object Span

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Span.type
sealed trait Span

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Code
class Error
class Sequence
class Strong
class Text
class URI
class Weak
Show all
Self type

Inherited and Abstract types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def blocks(helpDoc: HelpDoc, helpDocs0: HelpDoc*): HelpDoc
def descriptionList(definitions: (Span, HelpDoc)*): HelpDoc
def enumeration(elements: HelpDoc*): HelpDoc
def h1(t: String): HelpDoc
def h1(span: Span): HelpDoc
def h2(t: String): HelpDoc
def h2(span: Span): HelpDoc
def h3(t: String): HelpDoc
def h3(span: Span): HelpDoc
def p(t: String): HelpDoc
def p(span: Span): HelpDoc

Concrete fields

val empty: HelpDoc