caseapp.core.help
package caseapp.core.help
Members list
Concise view
Type members
Classlikes
case class CommandHelp(args: Seq[Arg], argsNameOption: Option[String], helpMessage: Option[HelpMessage])
Attributes
- Graph
- Supertypes
Provides usage and help messages related to T
Attributes
object HelpCompanion
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- HelpCompanion.type
case class HelpFormat(progName: Attrs, commandName: Attrs, option: Attrs, newLine: String, sortGroups: Option[Seq[String] => Seq[String]], sortedGroups: Option[Seq[String]], hiddenGroups: Option[Seq[String]], sortCommandGroups: Option[Seq[String] => Seq[String]], sortedCommandGroups: Option[Seq[String]], hidden: Attrs, terminalWidthOpt: Option[Int], filterArgs: Option[Arg => Boolean], filterArgsWhenShowHidden: Option[Arg => Boolean], hiddenGroupsWhenShowHidden: Option[Seq[String]])
Attributes
- Companion:
- object
- Graph
- Supertypes
object HelpFormat
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- HelpFormat.type
object PlatformUtil
Attributes
- Graph
- Supertypes
- Self type
- PlatformUtil.type
Attributes
- Graph
- Supertypes
case class RuntimeCommandsHelp(progName: String, description: Option[String], defaultHelp: Help[_], commands: Seq[RuntimeCommandHelp[_]], summaryDesc: Option[String])
Attributes
- Graph
- Supertypes
Attributes
- Graph
- Supertypes
Attributes
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- WithFullHelp.type
Attributes
- Graph
- Supertypes
- Known subtypes
- object WithFullHelp.type
Helper to add --usage and --help options to an existing type T.
Helper to add --usage and --help options to an existing type T.
Attributes
- T:
type to which usage and help options are added
- baseOrError:
parsed
Tin case of success, or error message else- help:
whether help was requested
- usage:
whether usage was requested
- Companion:
- object
- Graph
- Supertypes