com.github.rvesse.airline.annotations.help

Annotation Type Discussion

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface Discussion

Annotation that provides a discussion section for a commands help

Author:

rvesse

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	paragraphs An array of paragraphs of text that provides an extended discussion on the behaviour of the command.

Element Detail

paragraphs

public abstract String[] paragraphs

An array of paragraphs of text that provides an extended discussion on the behaviour of the command. Discussion typically goes into much greater detail about exact behaviour of commands particularly where complex commands may behave differently depending on the option combinations used.

Returns:

Command discussion

Default:

{}