HelpDoc

zio.cli.HelpDoc

See theHelpDoc companion object

sealed trait HelpDoc

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.

Attributes

Companion: object
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class DescriptionList

object Empty

class Enumeration

class Header

class Paragraph

class Sequence
Show all
Self type: HelpDoc