Static Methodswift-argument-parser 1.5.0ArgumentParser
usageString(includeHidden:)
Returns the usage text for this type.
ParsableArguments.swift:241static func usageString(includeHidden: Bool = false) -> String
Parameters
- includeHidden
Include hidden help information in the generated message.
Returns
The usage text for this type.
Other members in extension
Type members
static func completionScript(for: CompletionShell
) -> String Returns a shell completion script for the specified shell.
static func exit(withError: Error?
) -> Never Terminates execution with a message and exit code that is appropriate for the given error.
static func exitCode(for: Error
) -> ExitCode Returns the exit code for the given error.
static func fullMessage(for: Error, columns: Int?
) -> String Returns a full message for the given error, including usage information, if appropriate.
static func helpMessage(includeHidden: Bool, columns: Int?
) -> String Returns the text of the help screen for this type.
static func message(for: Error
) -> String Returns a brief message for the given error.
static func parse([String]?
) throws -> Self Parses a new instance of this type from command-line arguments.
static func parseOrExit([String]?
) -> Self Parses a new instance of this type from command-line arguments or exits with a relevant message.
Show implementation details (2)
Hide implementation details
static var _errorLabel: String
static func _dumpHelp(
) -> String Returns the JSON representation of this type.
Show obsolete interfaces (2)
Hide obsolete interfaces
static func fullMessage(for: Error
) -> String static func helpMessage(columns: Int?
) -> String Returns the text of the help screen for this type.