Module com.github.rvesse.airline
Annotation Interface ProseSection
Annotation that provides a prose section for a commands help
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString[]
An array of paragraphs of text that provides prose for the help sectionint
Suggested order in which the help section should be placed relative to other help sections
-
Element Details
-
title
String titleTitle of the section- Returns:
- Title
-
paragraphs
String[] paragraphsAn array of paragraphs of text that provides prose for the help section- Returns:
- Paragraphs
- Default:
{}
-
suggestedOrder
int suggestedOrderSuggested order in which the help section should be placed relative to other help sectionsValues 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
-