package helpdoc
- Source
- package.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- helpdoc
- Help
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
-
final
case class
Chunk[A](run: Option[A]) extends Product with Serializable
The free monoid on a semigroup A
-
final
case class
OptDescStyle(sep: Doc, hidden: Boolean, surround: Boolean) extends Product with Serializable
Style for rendering an option.
- final case class ParserHelp(error: Chunk[Doc], header: Chunk[Doc], usage: Chunk[Doc], body: Chunk[Doc], footer: Chunk[Doc]) extends Product with Serializable
Value Members
-
def
bodyHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
-
def
briefDesc[A](pprefs: ParserPrefs, parser: types.Parser[A]): Chunk[Doc]
Generate a brief help text for a parser.
Generate a brief help text for a parser.
- Definition Classes
- Help
-
def
cmdDesc[A](p: types.Parser[A]): Chunk[Doc]
Generate descriptions for commands.
Generate descriptions for commands.
- Definition Classes
- Help
-
def
errorHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
-
def
footerHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
-
def
fullDesc[A](pprefs: ParserPrefs, parser: types.Parser[A]): Chunk[Doc]
Generate a full help text for a parser.
Generate a full help text for a parser.
- Definition Classes
- Help
-
def
headerHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- 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.
- Definition Classes
- Help
-
def
parserHelp[A](pprefs: ParserPrefs, parser: types.Parser[A]): ParserHelp
Generate the help text for a program.
Generate the help text for a program.
- Definition Classes
- Help
-
def
parserUsage[A](pprefs: ParserPrefs, parser: types.Parser[A], progName: String): Doc
Generate option summary.
Generate option summary.
- Definition Classes
- Help
-
def
usageHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- object Chunk extends Serializable
- object ParserHelp extends Serializable