optparse-applicative/optparse_applicative.helpdoc

optparse_applicative.helpdoc

package optparse_applicative.helpdoc

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

Companion
object
object Chunk
Companion
class
final case class OptDescStyle(sep: Doc, hidden: Boolean, surround: Boolean)

Style for rendering an option.

Style for rendering an option.

final case class ParserHelp(error: Chunk[Doc], header: Chunk[Doc], usage: Chunk[Doc], body: Chunk[Doc], footer: Chunk[Doc])
Companion
object
object ParserHelp
Companion
class

Value members

Inherited methods

def bodyHelp(chunk: Chunk[Doc]): ParserHelp
Inherited from
Help
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.

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

Generate descriptions for commands.

Generate descriptions for commands.

Inherited from
Help
def errorHelp(chunk: Chunk[Doc]): ParserHelp
Inherited from
Help
def footerHelp(chunk: Chunk[Doc]): ParserHelp
Inherited from
Help
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.

Inherited from
Help
def headerHelp(chunk: Chunk[Doc]): ParserHelp
Inherited from
Help
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.

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

Generate the help text for a program.

Generate the help text for a program.

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

Generate option summary.

Generate option summary.

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