Class CustomHelpTextGenerator

A default implementation of help text generation.

Inheritance
Object
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator
CustomHelpTextGenerator
Implements
McMaster.Extensions.CommandLineUtils.HelpText.IHelpTextGenerator
Inherited Members
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.ColumnSeparatorLength
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.Generate(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateBody(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateUsage(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandArgument>, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandOption>, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandLineApplication>)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateArguments(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandArgument>, System.Int32)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateOptions(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandOption>, System.Int32)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateCommands(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter, System.Collections.Generic.IReadOnlyList<McMaster.Extensions.CommandLineUtils.CommandLineApplication>, System.Int32)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.Format(McMaster.Extensions.CommandLineUtils.CommandOption)
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.IndentWriter
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.Singleton
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.SortCommandsByName
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.MaxLineLength
Namespace: AnalysisPrograms.Production
Assembly: AnalysisPrograms.dll
Syntax
public class CustomHelpTextGenerator : DefaultHelpTextGenerator, IHelpTextGenerator

Constructors

| Improve this Doc View Source

CustomHelpTextGenerator()

Declaration
public CustomHelpTextGenerator()

Properties

| Improve this Doc View Source

EnvironmentOptions

Declaration
public Dictionary<string, string> EnvironmentOptions { get; set; }
Property Value
Type Description
Dictionary<String, String>

Methods

| Improve this Doc View Source

FormatCommands(TextWriter, List<CommandLineApplication>)

Declaration
public void FormatCommands(TextWriter output, List<CommandLineApplication> commands)
Parameters
Type Name Description
TextWriter output
List<McMaster.Extensions.CommandLineUtils.CommandLineApplication> commands
| Improve this Doc View Source

GenerateFooter(CommandLineApplication, TextWriter)

Declaration
protected override void GenerateFooter(CommandLineApplication application, TextWriter output)
Parameters
Type Name Description
McMaster.Extensions.CommandLineUtils.CommandLineApplication application
TextWriter output
Overrides
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateFooter(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter)
| Improve this Doc View Source

GenerateHeader(CommandLineApplication, TextWriter)

Declaration
protected override void GenerateHeader(CommandLineApplication application, TextWriter output)
Parameters
Type Name Description
McMaster.Extensions.CommandLineUtils.CommandLineApplication application
TextWriter output
Overrides
McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator.GenerateHeader(McMaster.Extensions.CommandLineUtils.CommandLineApplication, System.IO.TextWriter)

Implements

McMaster.Extensions.CommandLineUtils.HelpText.IHelpTextGenerator

Extension Methods