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

Option

data class Option(val names: Set<String>, val secondaryNames: Set<String>, val metavar: String?, val help: String, val nvalues: IntRange, val tags: Map<String, String>, val acceptsNumberValueWithoutName: Boolean, val acceptsUnattachedValue: Boolean, val groupName: String?) : HelpFormatter.ParameterHelp

Constructors

constructor(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: IntRange, tags: Map<String, String>, acceptsNumberValueWithoutName: Boolean, acceptsUnattachedValue: Boolean, groupName: String?)

Properties

acceptsNumberValueWithoutName

val acceptsNumberValueWithoutName: Boolean

True if this option can be called like -1, -2 etc.

acceptsUnattachedValue

val acceptsUnattachedValue: Boolean

True if this option can be called like --option 1 in addition to --option=1

val groupName: String?

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

val help: String

The option's description

val metavar: String?

The metavar to display for the option if it takes values

val names: Set<String>

The names that can be used to invoke this option

val nvalues: IntRange

The number of values that this option takes

val secondaryNames: Set<String>

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

val tags: Map<String, String>

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