PlaintextHelpFormatter

class PlaintextHelpFormatter(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false) : AbstractHelpFormatter<String>

A simple help formatter that outputs plain text.

It doesn't support text wrapping, markdown, or any other styles or formatting.

Constructors

constructor(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false)

open override fun formatHelp(error: UsageError?, prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String): String

Return a help string to show the user.