clikt/com.github.ajalt.clikt.output/HelpFormatter/ParameterHelp/Option

Option

data class Option(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: Int, tags: Map<String, String>, groupName: String?) : HelpFormatter.ParameterHelp

Parameters

names

The names that can be used to invoke this option

secondaryNames

Secondary names that can be used to e.g. disable the option

metavar

The metavar to display for the option if it takes values

help

The option's description

nvalues

The number of values that this option takes

tags

Any extra tags to display with the help message for this option

groupName

The name of the group this option belongs to, if there is one and its name should be shown in the help message

Constructors

fun Option(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: Int, tags: Map<String, String>, groupName: String?)

Properties

val groupName: String?

val help: String

val metavar: String?

val names: Set<String>

val nvalues: Int

val secondaryNames: Set<String>

val tags: Map<String, String>