Added documentation to undocumented functions

This commit is contained in:
Lukasz Baldyga committed 2020-11-02 15:40:50 +00:00
1 parent c1c6cd9c12
commit 6e3cfb01cc
1 file changed
+14
@@ -74,6 +74,15 @@ namespace Advanced_Software_Engineering {
}
/// <summary>
/// Strips the strings of the full array. See <see cref="Strip(string)"/>
/// </summary>
/// <example>
/// string[] tmp = {" text ", " ", " with", "spaces ", ""};
/// Console.WriteLine(StripStringArray(tmp)); // => {"text", "with", "spaces"}
/// </example>
/// <param name="array">Dirty array with spaces</param>
/// <returns>A stripped aray</returns>
public static List<string> StripStringArray(string[] array) {
List<string> newStringList = new List<string>();
@@ -86,6 +95,11 @@ namespace Advanced_Software_Engineering {
return newStringList;
}
/// <summary>
/// Parses the commands into a directry that Commander can use. See <see cref="Commander"/>
/// </summary>
/// <param name="text">A string command</param>
/// <returns>Directory with the command and its parameters cleanly separated</returns>
public static Dictionary<string, string[]> CommandAndParameterParser(string text) {
Dictionary<string, string[]> commandAndParameters = new Dictionary<string, string[]>();