com.github.rvesse.airline.annotations.help

Annotation Type ProseSection

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

Annotation that provides a prose section for a commands help

Author:

rvesse

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	title Title of the section

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	paragraphs An array of paragraphs of text that provides prose for the help section
int	suggestedOrder Suggested order in which the help section should be placed relative to other help sections

Element Detail

title

public abstract String title

Title of the section

Returns:

Title

paragraphs

public abstract String[] paragraphs

An array of paragraphs of text that provides prose for the help section

Returns:

Paragraphs

Default:

{}

suggestedOrder

public abstract int suggestedOrder

Suggested order in which the help section should be placed relative to other help sections

Values less than zero will typically place the section before the standard sections while values greater than or equal to zero will place the section after the standard sections.

Returns:

Suggested order

Default:

0