Annotation Interface ExternalExamples
Annotation that provides an examples section for a commands help via two external resources in textual format
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionSource containing the descriptions of the examplesSource containing the examples -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass
<? extends ParagraphsParser> The parser to use to translate the source specified byexampleSource()
anddescriptionSource()
into paragraphsClass<? extends ResourceLocator>[]
Resource locators used to find the resources specified inexampleSource()
anddescriptionSource()
-
Element Details
-
exampleSource
String exampleSourceSource containing the examples- Returns:
- Example source
-
descriptionSource
String descriptionSourceSource containing the descriptions of the examples- Returns:
- Description source
-
sourceLocators
Class<? extends ResourceLocator>[] sourceLocatorsResource locators used to find the resources specified inexampleSource()
anddescriptionSource()
- 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 byexampleSource()
anddescriptionSource()
into paragraphs- Returns:
- Paragraphs parser
- Default:
com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class
-