final class Help[T] extends Product with Serializable
Provides usage and help messages related to T
- Alphabetic
- By Inheritance
- Help
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Help(args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String])
- new Help(args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String], optionsDesc: String, nameFormatter: Formatter[Name], helpMessage: Option[HelpMessage])
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val appName: String
- val appVersion: String
- val args: Seq[Arg]
- val argsNameOption: Option[String]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
canEqual(obj: Any): Boolean
- Definition Classes
- Help → Equals
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def duplicates: Map[String, Seq[Arg]]
- def ensureNoDuplicates(): Unit
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
- Definition Classes
- Help → Equals → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- Help → AnyRef → Any
-
def
help: String
Full multi-line help message for
T
.Full multi-line help message for
T
.Includes both
usageMessage
andoptionsMessage
- val helpMessage: Option[HelpMessage]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val nameFormatter: Formatter[Name]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
options: String
Options description for
T
- val optionsDesc: String
-
def
productArity: Int
- Definition Classes
- Help → Product
-
def
productElement(n: Int): Any
- Definition Classes
- Help → Product
-
def
productIterator: Iterator[Any]
- Definition Classes
- Product
-
def
productPrefix: String
- Definition Classes
- Help → Product
- val progName: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- Help → AnyRef → Any
-
def
usage: String
One-line usage message for
T
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withAppName(appName: String): Help[Nothing]
- def withAppVersion(appVersion: String): Help[Nothing]
- def withArgs(args: Seq[Arg]): Help[Nothing]
- def withArgsNameOption(argsNameOption: Option[String]): Help[Nothing]
-
def
withHelp: Help[WithHelp[T]]
Add help and usage options.
- def withHelpMessage(helpMessage: Option[HelpMessage]): Help[Nothing]
- def withNameFormatter(nameFormatter: Formatter[Name]): Help[Nothing]
- def withOptionsDesc(optionsDesc: String): Help[Nothing]
- def withProgName(progName: String): Help[Nothing]