HelpFormatter

interface HelpFormatter

Creates help and usage strings for a command.

You can set the formatter for a command when configuring the context.

Types

ParameterHelp
Link copied to clipboard
common
sealed class ParameterHelp
Tags
Link copied to clipboard
common
object Tags
Standard tag names for parameter help

Functions

formatHelp
Link copied to clipboard
common
abstract fun formatHelp(prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String = ""): String
Create the full help string.
formatUsage
Link copied to clipboard
common
abstract fun formatUsage(parameters: List<HelpFormatter.ParameterHelp>, programName: String = ""): String
Create the one-line usage information for a command.

Inheritors

CliktHelpFormatter
Link copied to clipboard