Code clean up

a
2020-12-04 18:52:26 +00:00
1 parent 12455d3267
commit 2884bbe8ca
@@ -12,6 +12,7 @@ namespace Advanced_Software_Engineering {
    /// The drawer is responsible for drawing on the graphics object.
    /// </summary>
    public class Drawer {
+
        /// <summary>
        /// Value storage is used for storing all of the variables and their IValues. See <see cref="ValueStorage"/> and see <see cref="IValue"/>
        /// </summary>
@@ -1,6 +1,7 @@
 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.
@@ -1,4 +1,5 @@
 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// Declares a method. See <see cref="DrawingVerbs.Actions.NoOp"/> because these classes behave similarly
    /// </summary>
@@ -17,7 +18,7 @@
        }

        /// <summary>
-        /// Adds a verb to the verb list. More specifically, the verb list of the MethodChunk. 
+        /// Adds a verb to the verb list. More specifically, the verb list of the MethodChunk.
        /// See <see cref="MethodChunk"/>
        /// </summary>
        /// <param name="verb">The verb to add</param>
@@ -2,6 +2,7 @@
 using System.Collections.Generic;

 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// A ForChunk is similar to a <see cref="WhileChunk"/>. It executes a specific number of times.
    /// </summary>
@@ -43,4 +44,4 @@ namespace Advanced_Software_Engineering.Verbs.Flow {
            valueStorage.DecreaseStack();
        }
    }
-}
+}
@@ -1,8 +1,10 @@
 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
-    /// A Collection of chunks to be executed. They extend IVerb because they should be interchangable. 
+    /// A Collection of chunks to be executed. They extend IVerb because they should be interchangable.
    /// </summary>
    public interface IVerbChunk : IVerb {
+
        /// <summary>
        /// Adds a verb to the verb list
        /// </summary>
@@ -2,6 +2,7 @@
 using System.Collections.Generic;

 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// A simple If Object
    /// </summary>
@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Drawing;

 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// The method chunk class
    /// </summary>
@@ -1,6 +1,7 @@
 using System.Collections.Generic;

 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// A simple VerbChunk. Used for storing and executing a bunch of verbs
    /// </summary>
@@ -2,6 +2,7 @@
 using System.Collections.Generic;

 namespace Advanced_Software_Engineering.Verbs.Flow {
+
    /// <summary>
    /// A Chunk that loops over its code
    /// </summary>
@@ -2,6 +2,7 @@
 using System;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// Declares a variable
    /// </summary>
@@ -48,8 +49,9 @@ namespace Advanced_Software_Engineering.Verbs.Value {

            return true;
        }
+
        /// <summary>
-        /// Creates a new Declare variable 
+        /// Creates a new Declare variable
        /// </summary>
        /// <param name="storage">The storage to use</param>
        /// <param name="assignment">The assignment</param>
@@ -1,10 +1,12 @@
 using System.Drawing;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// A value
    /// </summary>
    public interface IValue {
+
        /// <summary>
        /// The description of the value
        /// </summary>
@@ -1,6 +1,7 @@
 using System;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// Used for updating the variables
    /// </summary>
@@ -3,6 +3,7 @@ using Advanced_Software_Engineering.Verbs.Value.ValueTypes;
 using System;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// Value factory creates values
    /// </summary>
@@ -2,6 +2,7 @@
 using System.Collections.Generic;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// The storage for all the values
    /// </summary>
@@ -2,10 +2,12 @@
 using System.Drawing;

 namespace Advanced_Software_Engineering.Verbs.Value {
+
    /// <summary>
    /// Expression values are used when there are two IValues that need to be added or subtracted or anything from each other.
    /// </summary>
    public class ExpressionValue : IValue {
+
        /// <summary>
        /// An operation denoting addition
        /// </summary>
@@ -26,7 +28,6 @@ namespace Advanced_Software_Engineering.Verbs.Value {
        /// </summary>
        public const int DIVIDE = 3;

-
        private readonly IValue variable1;
        private readonly IValue variable2;
        private readonly int operation;
@@ -2,6 +2,7 @@
 using System.Drawing;

 namespace Advanced_Software_Engineering.Verbs.Value.ValueTypes {
+
    /// <summary>
    /// Variable value is responsible for setting up values for <see cref="UpdateVariable"/> to then update
    /// </summary>