clikt / com.github.ajalt.clikt.output / PlaintextHelpFormatter / formatHelp

formatHelp

open fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String): String

Overrides HelpFormatter.formatHelp

Create the full help string.

Parameters

prolog - Text to display before any parameter information

epilog - Text to display after any parameter information

parameters - Information about the command's parameters

programName - The name of the currently executing program