case-app
API
Generated with
case-app/caseapp/caseapp.core/caseapp.core.help/Help

Help

caseapp.core.help.Help
See theHelp companion object
case class Help[T](args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String], optionsDesc: String, nameFormatter: Formatter[Name], helpMessage: Option[HelpMessage])

Provides usage and help messages related to T

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def duplicates: Map[String, Seq[Arg]]
def ensureNoDuplicates(): Unit
def help: String

Full multi-line help message for T.

Full multi-line help message for T.

Includes both usageMessage and optionsMessage

Attributes

def help(format: HelpFormat): String
def help(format: HelpFormat, showHidden: Boolean): String
def nonEmpty: Boolean
def options: String

Options description for T

Options description for T

Attributes

def printHelp(b: StringBuilder, format: HelpFormat, showHidden: Boolean): Unit
def printOptions(b: StringBuilder, format: HelpFormat, showHidden: Boolean): Unit
def printUsage(b: StringBuilder, format: HelpFormat): Unit
def usage: String

One-line usage message for T

One-line usage message for T

Attributes

def usage(format: HelpFormat): String
def withHelp: Help[WithHelp[T]]

Add help and usage options.

Add help and usage options.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with