Package

optparse_applicative

helpdoc

Permalink

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

Type Members

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

    Permalink

    The free monoid on a semigroup A

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

    Permalink

    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

    Permalink

Value Members

  1. object Chunk extends Serializable

    Permalink

  2. object ParserHelp extends Serializable

    Permalink

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

    Permalink
    Definition Classes
    Help

  4. def briefDesc[A](pprefs: ParserPrefs, parser: types.Parser[A]): Chunk[Doc]

    Permalink

    Generate a brief help text for a parser.

    Generate a brief help text for a parser.

    Definition Classes
    Help

  5. def cmdDesc[A](p: types.Parser[A]): Chunk[Doc]

    Permalink

    Generate descriptions for commands.

    Generate descriptions for commands.

    Definition Classes
    Help

  6. def errorHelp(chunk: Chunk[Doc]): ParserHelp

    Permalink
    Definition Classes
    Help

  7. def footerHelp(chunk: Chunk[Doc]): ParserHelp

    Permalink
    Definition Classes
    Help

  8. def fullDesc[A](pprefs: ParserPrefs, parser: types.Parser[A]): Chunk[Doc]

    Permalink

    Generate a full help text for a parser.

    Generate a full help text for a parser.

    Definition Classes
    Help

  9. def headerHelp(chunk: Chunk[Doc]): ParserHelp

    Permalink
    Definition Classes
    Help

  10. def optDesc[A](pprefs: ParserPrefs, style: OptDescStyle, info: OptHelpInfo, opt: Opt[A]): Chunk[Doc]

    Permalink

    Generate description for a single option.

    Generate description for a single option.

    Definition Classes
    Help

  11. def parserHelp[A](pprefs: ParserPrefs, parser: types.Parser[A]): ParserHelp

    Permalink

    Generate the help text for a program.

    Generate the help text for a program.

    Definition Classes
    Help

  12. def parserUsage[A](pprefs: ParserPrefs, parser: types.Parser[A], progName: String): Doc

    Permalink

    Generate option summary.

    Generate option summary.

    Definition Classes
    Help

  13. def usageHelp(chunk: Chunk[Doc]): ParserHelp

    Permalink
    Definition Classes
    Help

Inherited from Help

Inherited from AnyRef

Inherited from Any

Ungrouped