optparse-applicative
API
Generated with
optparse-applicative/optparse_applicative/optparse_applicative.helpdoc

optparse_applicative.helpdoc

package optparse_applicative.helpdoc

Members list

Type members

Classlikes

final case class Chunk[A](run: Option[A])

The free monoid on a semigroup A

The free monoid on a semigroup A

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Chunk

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Chunk.type
final case class OptDescStyle(sep: Doc, hidden: Boolean, surround: Boolean)

Style for rendering an option.

Style for rendering an option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ParserHelp(error: Chunk[Doc], header: Chunk[Doc], usage: Chunk[Doc], body: Chunk[Doc], footer: Chunk[Doc])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParserHelp

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ParserHelp.type

Value members

Inherited methods

def bodyHelp(chunk: Chunk[Doc]): ParserHelp

Attributes

Inherited from:
Help (hidden)
def briefDesc[A](pprefs: ParserPrefs, parser: Parser[A]): Chunk[Doc]

Generate a brief help text for a parser.

Generate a brief help text for a parser.

Attributes

Inherited from:
Help (hidden)
def cmdDesc[A](p: Parser[A]): Chunk[Doc]

Generate descriptions for commands.

Generate descriptions for commands.

Attributes

Inherited from:
Help (hidden)
def errorHelp(chunk: Chunk[Doc]): ParserHelp

Attributes

Inherited from:
Help (hidden)
def footerHelp(chunk: Chunk[Doc]): ParserHelp

Attributes

Inherited from:
Help (hidden)
def fullDesc[A](pprefs: ParserPrefs, parser: Parser[A]): Chunk[Doc]

Generate a full help text for a parser.

Generate a full help text for a parser.

Attributes

Inherited from:
Help (hidden)
def headerHelp(chunk: Chunk[Doc]): ParserHelp

Attributes

Inherited from:
Help (hidden)
def optDesc[A](pprefs: ParserPrefs, style: OptDescStyle, info: OptHelpInfo, opt: Opt[A]): Chunk[Doc]

Generate description for a single option.

Generate description for a single option.

Attributes

Inherited from:
Help (hidden)
def parserHelp[A](pprefs: ParserPrefs, parser: Parser[A]): ParserHelp

Generate the help text for a program.

Generate the help text for a program.

Attributes

Inherited from:
Help (hidden)
def parserUsage[A](pprefs: ParserPrefs, parser: Parser[A], progName: String): Doc

Generate option summary.

Generate option summary.

Attributes

Inherited from:
Help (hidden)
def usageHelp(chunk: Chunk[Doc]): ParserHelp

Attributes

Inherited from:
Help (hidden)
Generated with