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 AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
MarkdownUsageHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)

Method Summary

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 option
void	outputArgumentsSynopsis(UsagePrinter printer, ArgumentsMetadata arguments)
void	outputArgumentsTitle(UsagePrinter printer, ArgumentsMetadata arguments)
void	outputHelpSection(UsagePrinter out, HelpSection section)	Outputs a help section
protected 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 option
void	outputOptions(UsagePrinter out, List<OptionMetadata> options)
void	outputOptionsSynopsis(UsagePrinter printer, List<OptionMetadata> options)
void	outputOptionSynopsis(UsagePrinter printer, OptionMetadata option)
void	outputOptionTitle(UsagePrinter printer, OptionMetadata option)

Methods inherited from class AbstractUsageGenerator

getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownUsageHelper

public MarkdownUsageHelper(Comparator<? super OptionMetadata> optionComparator,
 boolean includeHidden)

Method Details

outputOptions

public void outputOptions(UsagePrinter out,
 List<OptionMetadata> options)
                   throws IOException

Throws:

IOException

outputOptionRestriction

protected void outputOptionRestriction(UsagePrinter out,
 OptionMetadata option,
 OptionRestriction restriction,
 HelpHint hint)
                                throws IOException

Outputs documentation about a restriction on an option

Parameters:

out - Usage printer

option - Option meta-data

restriction - Restriction

hint - Help hint

Throws:

IOException - Thrown if there is a problem generating usage output

outputHint

protected void outputHint(UsagePrinter out,
 HelpHint hint,
 boolean newPara)
                   throws IOException

Throws:

IOException

calculateMaxRows

public static int calculateMaxRows(HelpHint hint)

outputArguments

public <T> void outputArguments(UsagePrinter out,
 ArgumentsMetadata arguments,
 ParserMetadata<T> parserConfig)
                         throws IOException

Throws:

IOException

outputArgumentsRestriction

protected void outputArgumentsRestriction(UsagePrinter descriptionPrinter,
 ArgumentsMetadata arguments,
 ArgumentsRestriction restriction,
 HelpHint hint)
                                   throws IOException

Outputs documentation about a restriction on an option

Parameters:

descriptionPrinter - Description printer

arguments - Arguments meta-data

restriction - Restriction

hint - Help hint

Throws:

IOException - Thrown if there is a problem generating usage output

outputHelpSection

public void outputHelpSection(UsagePrinter out,
 HelpSection section)
                       throws IOException

Outputs a help section

Parameters:

out - Usage printer

section - Help section

Throws:

IOException - Thrown if there is a problem generating usage output

outputOptionsSynopsis

public void outputOptionsSynopsis(UsagePrinter printer,
 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)