added help for commands.

This commit is contained in:
2018-12-08 21:28:58 -06:00
parent d73db03c72
commit c17af2248a
2 changed files with 21 additions and 0 deletions

View File

@@ -6,6 +6,18 @@ namespace RecrownedAthenaeum.Tools.CommandProcessor
{
interface ICommandEngineCommand
{
/// <summary>
/// Runs the command.
/// </summary>
/// <param name="arguments">Commands to be used. May be null.</param>
void Run(string[] arguments);
/// <summary>
/// Returns the help for the given argument.
/// If no argument is given (null), then returns overall help statement.
/// </summary>
/// <param name="argument">The argument the help string is for. Can be null for overall command help.</param>
/// <returns>The text to help understand the argument.</returns>
string Help(string argument);
}
}