Module com.github.rvesse.airline
Annotation Type Examples
-
@Retention(RUNTIME) @Target(TYPE) @Documented public @interface Examples
Annotation that provides an examples section for a commands help
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String[]
descriptions
An array of paragraphs of text where each paragraph described the corresponding example given in theexamples()
property.java.lang.String[]
examples
An array of lines of text to provide a series of example usages of the command.
-
-
-
Element Detail
-
examples
java.lang.String[] examples
An 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
java.lang.String[] descriptions
An 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:
- {}
-
-