Module com.github.rvesse.airline
Annotation Interface Examples
Annotation that provides an examples section for a commands help
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString[]
An array of paragraphs of text where each paragraph described the corresponding example given in theexamples()
property.String[]
An array of lines of text to provide a series of example usages of the command.
-
Element Details
-
examples
String[] examplesAn array of lines of text to provide a series of example usages of the command. Each example may be provided with a description using thedescriptions()
property. The data in these two properties is collated based on array indices.- Returns:
- Examples
- Default:
{}
-
descriptions
String[] descriptionsAn array of paragraphs of text where each paragraph described the corresponding example given in theexamples()
property. The data in these two properties is collated based on array indices.- Returns:
- Descriptions
- Default:
{}
-