Class MarkdownGlobalUsageGenerator<T>

    • Constructor Detail

      • MarkdownGlobalUsageGenerator

        public MarkdownGlobalUsageGenerator()
      • MarkdownGlobalUsageGenerator

        public MarkdownGlobalUsageGenerator​(boolean includeHidden)
      • MarkdownGlobalUsageGenerator

        public MarkdownGlobalUsageGenerator​(int columns)
      • MarkdownGlobalUsageGenerator

        public MarkdownGlobalUsageGenerator​(int columns,
                                            boolean includeHidden)
    • Method Detail

      • outputCommandList

        protected void outputCommandList​(UsagePrinter out,
                                         GlobalMetadata<T> global)
                                  throws java.io.IOException
        Outputs a documentation section listing the commands
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputSynopsis

        protected void outputSynopsis​(UsagePrinter out,
                                      GlobalMetadata<T> global)
                               throws java.io.IOException
        Outputs a documentation section with a synopsis of CLI usage
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputDescription

        protected void outputDescription​(UsagePrinter out,
                                         GlobalMetadata<T> global)
                                  throws java.io.IOException
        Outputs a documentation section with a description of the CLI
        Parameters:
        out - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputCommandDescription

        protected void outputCommandDescription​(UsagePrinter out,
                                                CommandGroupMetadata group,
                                                CommandMetadata command)
                                         throws java.io.IOException
        Outputs the description for a command
        Parameters:
        out - Usage printer
        group - Group meta-data
        command - Command meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputCommandUsages

        protected void outputCommandUsages​(UsagePrinter printer,
                                           GlobalMetadata<T> global)
                                    throws java.io.IOException
        Outputs the command usages for all groups
        Parameters:
        printer - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputDefaultGroupCommandUsages

        protected void outputDefaultGroupCommandUsages​(UsagePrinter printer,
                                                       GlobalMetadata<T> global)
                                                throws java.io.IOException
        Outputs the command usages for the commands in the default group
        Parameters:
        printer - Usage printer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputGroupCommandUsages

        protected void outputGroupCommandUsages​(UsagePrinter printer,
                                                GlobalMetadata<T> global,
                                                java.util.List<CommandGroupMetadata> groups)
                                         throws java.io.IOException
        Outputs the command usages for the commands in the given group
        Parameters:
        printer - Usage printer
        global - Global Meta-data
        groups - Groups Meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output