From 54edb0cec221ab004db2b27322e38a3a02114083 Mon Sep 17 00:00:00 2001
From: Lukasz Baldyga <c3ypt1c@gmail.com>
Date: Fri, 4 Dec 2020 17:10:48 +0000
Subject: [PATCH] Documented IfChunk

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

diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs
index 3fae85f..01e7736 100644
--- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs	
+++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs	
@@ -2,23 +2,39 @@
 using System.Collections.Generic;
 
 namespace Advanced_Software_Engineering.Verbs.Flow {
-
+    /// <summary>
+    /// A simple If Object
+    /// </summary>
     public class IfChunk : VerbChunk, IVerbChunk, IVerb {
         private readonly IValue conditional;
         private readonly ValueStorage valueStorage;
 
+        /// <summary>
+        /// Create a new if object
+        /// </summary>
+        /// <param name="valueStorage">The ValueStorage for increasing and decreasing the stack</param>
+        /// <param name="conditional">Preferably <see cref="Value.ValueTypes.BoolValue"/>, if the chunk should execute.</param>
         public IfChunk(ValueStorage valueStorage, IValue conditional) : base() {
             this.conditional = conditional;
             this.valueStorage = valueStorage;
             valueStorage.IncreaseStack();
         }
 
+        /// <summary>
+        /// Create a new if object
+        /// </summary>
+        /// <param name="valueStorage">The ValueStorage for increasing and decreasing the stack</param>
+        /// <param name="conditional">Preferably <see cref="Value.ValueTypes.BoolValue"/>, if the chunk should execute.</param>
+        /// <param name="oneLineVerb">A verb to execute in a single line</param>
         public IfChunk(ValueStorage valueStorage, IValue conditional, IVerb oneLineVerb) : base(new List<IVerb> { oneLineVerb }) {
             this.conditional = conditional;
             this.valueStorage = valueStorage;
             valueStorage.IncreaseStack();
         }
 
+        /// <summary>
+        /// Executes the chunk if the conditional is true
+        /// </summary>
         public new void ExecuteVerb() {
             valueStorage.IncreaseStack();
             if (conditional.ToBool()) base.ExecuteVerb();