Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Method: ConsoleColoredString GetUsageInfo(TranslationBase, Translation, Func<ConsoleColoredString, ConsoleColoredString>)

Declaration

public ConsoleColoredString GetUsageInfo(
    TranslationBase applicationTr = null,
    Translation tr = null,
    Func<ConsoleColoredString, ConsoleColoredString> helpProcessor = null
)

Summary

Generates and returns usage information, followed by an error message describing to the user what it was that the parser didn't understand.

Parameters

TranslationBaseapplicationTr An object containing translations for the documentation strings. Set this to null only if your application is definitely monolingual (unlocalisable).
Translationtr Contains translations for the messages used by the command-line parser. Set this to null only if your application is definitely monolingual (unlocalisable).
Func<ConsoleColoredString, ConsoleColoredString>helpProcessor Specifies a callback which is invoked on every documentation string retrieved from the DocumentationAttributes to generate the help text. This callback can modify the text arbitrarily.