argot-annotations/org.draftcode.argot.annotations/Flag

Flag

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Flag(val names: Array<String> = [], val help: String = "")

Declares a boolean flag on a Command constructor parameter.

The parameter must be a non-nullable Boolean: presence of the flag implies true, absence false. A Kotlin = false default is fine.

Parameters

names

the flag's names, primary first (for example ["--verbose", "-v"]).

help

help text for --help.

Properties

val help: String

val names: Array<String>