Documented Helper functions

This commit is contained in:
Lukasz Baldyga committed 2020-12-04 17:11:46 +00:00
1 parent a631d26c3d
commit 45e1877861
1 file changed
+17 -1
@@ -1,20 +1,36 @@
using System.Collections.Generic;
namespace Advanced_Software_Engineering {
/// <summary>
/// This class is a direct replacement to the dictionaries that were returned by <see cref="HelperFunctions.CommandAndParameterParser(string)"/>.
/// This class provides better intraface to the output.
/// </summary>
public class CommandAndParameterParserResult {
private readonly string command;
private readonly string[] parameters;
/// <summary>
/// Generates a new Result
/// </summary>
/// <param name="command">The command</param>
/// <param name="parameters">The parameters</param>
public CommandAndParameterParserResult(string command, string[] parameters) {
this.command = command;
this.parameters = parameters;
}
/// <summary>
/// Gets the command from the result
/// </summary>
/// <returns>the command</returns>
public string getCommand() {
return command;
}
/// <summary>
/// Gets the command parameters
/// </summary>
/// <returns>command parameters</returns>
public string[] getParameters() {
return parameters;
}