Class MarkdownUsageHelper
- java.lang.Object
-
- com.github.rvesse.airline.help.common.AbstractUsageGenerator
-
- com.github.rvesse.airline.help.markdown.MarkdownUsageHelper
-
public class MarkdownUsageHelper extends AbstractUsageGenerator
-
-
Field Summary
-
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
-
Constructor Summary
Constructors Constructor Description MarkdownUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static int
calculateMaxRows(HelpHint hint)
<T> void
outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected void
outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint)
Outputs documentation about a restriction on an optionvoid
outputArgumentsSynopsis(UsagePrinter printer, ArgumentsMetadata arguments)
void
outputArgumentsTitle(UsagePrinter printer, ArgumentsMetadata arguments)
void
outputHelpSection(UsagePrinter out, HelpSection section)
Outputs a help sectionprotected void
outputHint(UsagePrinter out, HelpHint hint, boolean newPara)
protected void
outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)
Outputs documentation about a restriction on an optionvoid
outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options)
void
outputOptionsSynopsis(UsagePrinter printer, java.util.List<OptionMetadata> options)
void
outputOptionSynopsis(UsagePrinter printer, OptionMetadata option)
void
outputOptionTitle(UsagePrinter printer, OptionMetadata option)
-
Methods inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
-
-
-
-
Constructor Detail
-
MarkdownUsageHelper
public MarkdownUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
-
Method Detail
-
outputOptions
public void outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options) throws java.io.IOException
- Throws:
java.io.IOException
-
outputOptionRestriction
protected void outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) throws java.io.IOException
Outputs documentation about a restriction on an option- Parameters:
out
- Usage printeroption
- Option meta-datarestriction
- Restrictionhint
- Help hint- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputHint
protected void outputHint(UsagePrinter out, HelpHint hint, boolean newPara) throws java.io.IOException
- Throws:
java.io.IOException
-
calculateMaxRows
public static int calculateMaxRows(HelpHint hint)
-
outputArguments
public <T> void outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) throws java.io.IOException
- Throws:
java.io.IOException
-
outputArgumentsRestriction
protected void outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) throws java.io.IOException
Outputs documentation about a restriction on an option- Parameters:
descriptionPrinter
- Description printerarguments
- Arguments meta-datarestriction
- Restrictionhint
- Help hint- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputHelpSection
public void outputHelpSection(UsagePrinter out, HelpSection section) throws java.io.IOException
Outputs a help section- Parameters:
out
- Usage printersection
- Help section- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputOptionsSynopsis
public void outputOptionsSynopsis(UsagePrinter printer, java.util.List<OptionMetadata> options)
-
outputOptionSynopsis
public void outputOptionSynopsis(UsagePrinter printer, OptionMetadata option)
-
outputArgumentsSynopsis
public void outputArgumentsSynopsis(UsagePrinter printer, ArgumentsMetadata arguments)
-
outputOptionTitle
public void outputOptionTitle(UsagePrinter printer, OptionMetadata option)
-
outputArgumentsTitle
public void outputArgumentsTitle(UsagePrinter printer, ArgumentsMetadata arguments)
-
-