Annotation Interface ExternalProse
Defines a prose section where the prose content is provided in a text file on the classpath
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass
<? extends ParagraphsParser> The parser to use to translate the source specified bysource()
into paragraphsClass<? extends ResourceLocator>[]
Resource locators used to find the resources specified insource()
int
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
-
source
String sourceSource containing the prose content- Returns:
- Source
-
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
-
sourceLocators
Class<? extends ResourceLocator>[] sourceLocatorsResource locators used to find the resources specified insource()
- Returns:
- Resource locators to use
- Default:
{com.github.rvesse.airline.parser.resources.ClasspathLocator.class, com.github.rvesse.airline.parser.resources.ModulePathLocator.class, com.github.rvesse.airline.parser.resources.FileLocator.class}
-
parser
Class<? extends ParagraphsParser> parserThe parser to use to translate the source specified bysource()
into paragraphs- Returns:
- Paragraph parser
- Default:
com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class
-