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

Option

data class Option : 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

Constructors

<init>

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

Properties

help

val help: String

The option's description

metavar

val metavar: String?

The metavar to display for the option if it takes values

names

val names: Set<String>

The names that can be used to invoke this option

nvalues

val nvalues: Int

The number of values that this option takes

secondaryNames

val secondaryNames: Set<String>

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