Help

Undocumented in source.

class Help {

int helpWidth;

bool sortSubCommands;

bool sortOptions;

bool showGlobalOptions;

inout(Command)[] visibleCommands(inout(Command) cmd);

inout(Option)[] visibleOptions(inout(Command) command);

inout(NegateOption)[] visibleNegateOptions(inout(Command) command);

inout(Option)[] visibleGlobalOptions(inout(Command) command);

inout(NegateOption)[] visibleGlobalNegateOptions(inout(Command) command);

inout(Argument)[] visibleArguments(inout(Command) command);

string commandUsage(Command cmd);

}

Members

Functions

argumentDesc string argumentDesc(Argument arg): Undocumented in source. Be warned that the author may not have intended to support it.
argumentTerm string argumentTerm(Argument arg): Undocumented in source. Be warned that the author may not have intended to support it.
commandDesc string commandDesc(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
commandUsage string commandUsage(Command cmd): get the usage of command
formatHelp string formatHelp(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
longestArgumentTermLength int longestArgumentTermLength(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
longestGlobalOptionTermLength int longestGlobalOptionTermLength(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
longestOptionTermLength int longestOptionTermLength(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
longestSubcommandTermLength int longestSubcommandTermLength(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
optionDesc string optionDesc(Option opt): Undocumented in source. Be warned that the author may not have intended to support it.
optionDesc string optionDesc(NegateOption opt): Undocumented in source. Be warned that the author may not have intended to support it.
optionTerm string optionTerm(Option opt): Undocumented in source. Be warned that the author may not have intended to support it.
optionTerm string optionTerm(NegateOption opt): Undocumented in source. Be warned that the author may not have intended to support it.
paddWidth int paddWidth(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
subCommandDesc string subCommandDesc(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
subCommandTerm string subCommandTerm(Command cmd): Undocumented in source. Be warned that the author may not have intended to support it.
visibleArguments inout(Argument)[] visibleArguments(inout(Command) command): get the list of arguments
visibleCommands inout(Command)[] visibleCommands(inout(Command) cmd): get the list of not hidden sub commands
visibleGlobalNegateOptions inout(NegateOption)[] visibleGlobalNegateOptions(inout(Command) command): get the list of not hidden global negate options
visibleGlobalOptions inout(Option)[] visibleGlobalOptions(inout(Command) command): get the list of not hidden global options
visibleNegateOptions inout(NegateOption)[] visibleNegateOptions(inout(Command) command): get the list of not hidden negate options
visibleOptions inout(Option)[] visibleOptions(inout(Command) command): get the list of not hidden options
wrap string wrap(string str, int width, int indent): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

helpWidth int helpWidth;: the help print's max coloum width
showGlobalOptions bool showGlobalOptions;: whether show global options, which is not recommended to turn on it
sortOptions bool sortOptions;: whether sort the options on help print
sortSubCommands bool sortSubCommands;: whether sort the sub commands on help print

Help

Members

Functions

Variables

Meta

Source