Packages

package helpdoc

Source
package.scala
Linear Supertypes
Help, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. helpdoc
  2. Help
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Chunk[A](run: Option[A]) extends Product with Serializable

    The free monoid on a semigroup A

  2. final case class OptDescStyle(sep: Doc, hidden: Boolean, surround: Boolean) extends Product with Serializable

    Style for rendering an option.

  3. 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

  1. def bodyHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  2. 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
  3. def cmdDesc[A](p: types.Parser[A]): Chunk[Doc]

    Generate descriptions for commands.

    Generate descriptions for commands.

    Definition Classes
    Help
  4. def errorHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  5. def footerHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  6. 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
  7. def headerHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  8. 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
  9. 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
  10. def parserUsage[A](pprefs: ParserPrefs, parser: types.Parser[A], progName: String): Doc

    Generate option summary.

    Generate option summary.

    Definition Classes
    Help
  11. def usageHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  12. object Chunk extends Serializable
  13. object ParserHelp extends Serializable

Inherited from Help

Inherited from AnyRef

Inherited from Any

Ungrouped