Class MarkdownUsageHelper

    • 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 printer
        option - Option meta-data
        restriction - Restriction
        hint - 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)
      • 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 printer
        arguments - Arguments meta-data
        restriction - Restriction
        hint - 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 printer
        section - Help section
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output