From 45e187786130c12214defe8d78b8ef8c3944dd65 Mon Sep 17 00:00:00 2001
From: Lukasz Baldyga <c3ypt1c@gmail.com>
Date: Fri, 4 Dec 2020 17:11:46 +0000
Subject: [PATCH] Documented Helper functions

---
 .../HelperFunctions.cs                         | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs b/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs
index 77485d2..cba9f8e 100644
--- a/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs	
+++ b/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs	
@@ -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;
         }