ydeng/recrownedathenaeum
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
Harrison Deng 2018-12-09 01:09:50 -06:00
parent b6581cfb47
commit 3a0bbc1e89
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RecrownedAthenaeum.ConsoleTools/CommandProcessor/EngineCommand.cs
View File

@ -51,6 +51,8 @@ namespace RecrownedAthenaeum.Tools.CommandProcessor
/// <summary> /// <summary>
/// Returns the help for the given argument for this command. If no argument is defined, general help for the command should be given. /// Returns the help for the given argument for this command. If no argument is defined, general help for the command should be given.
/// If no argument is given (null), then returns overall help statement. /// If no argument is given (null), then returns overall help statement.
/// Overall help should list possible arguments for user to use "help [command] [arg]" format.
/// Arguments can then be separately returned from help as the help command will pass in the argument the user requests to see in detail in the parameter.
/// </summary> /// </summary>
/// <param name="argument">The argument the help string is for. Can be null for overall command help.</param> /// <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> /// <returns>The text to help understand the argument.</returns>