HelpFormatter

interface HelpFormatter

Creates help and usage strings for a command.

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

Inheritors

Types

Link copied to clipboard
sealed class ParameterHelp
Link copied to clipboard
object Tags

Standard tag names for parameter help

Functions

Link copied to clipboard
abstract fun formatHelp(error: UsageError?, prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String = ""): String

Return a help string to show the user.