From ec11d03cc84522093c91abdba5356ece2f1fb7ad Mon Sep 17 00:00:00 2001
From: Lukasz Baldyga <c3ypt1c@gmail.com>
Date: Mon, 2 Nov 2020 09:45:09 +0000
Subject: [PATCH] Documented VerbFactory

---
 .../Verbs/VerbFactory.cs                             | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs
index 0a24200..c5ab264 100644
--- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs	
+++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs	
@@ -10,7 +10,19 @@ using Advanced_Software_Engineering.Verbs;
 using Advanced_Software_Engineering.Verbs.DrawingVerbs;
 
 namespace Advanced_Software_Engineering {
+    /// <summary>
+    /// This class is responsible for creating Verbs.
+    /// </summary>
     public class VerbFactory {
+        /// <summary>
+        /// This function returns a Verb from a command and drawer.
+        /// </summary>
+        /// <remarks>
+        /// This factory is specifically useful since it automatically converts the parameters to what they should be.
+        /// </remarks>
+        /// <param name="drawer">The drawer to affect</param>
+        /// <param name="fullCommand">The command as a string</param>
+        /// <returns>A verb that maches the command</returns>
         public static Verb MakeVerb(Drawer drawer, string fullCommand) {
 
             Dictionary<string, string[]> commandAndParameters = SettingsAndHelperFunctions.CommandAndParameterParser(fullCommand);