diff --git a/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs b/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs index febf3b0..debaa66 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs @@ -12,6 +12,7 @@ namespace Advanced_Software_Engineering { /// The drawer is responsible for drawing on the graphics object. /// public class Drawer { + /// /// Value storage is used for storing all of the variables and their IValues. See and see /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs b/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs index cba9f8e..04052d0 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs @@ -1,6 +1,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering { + /// /// This class is a direct replacement to the dictionaries that were returned by . /// This class provides better intraface to the output. diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/DeclareMethod.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/DeclareMethod.cs index f73da71..cd7e497 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/DeclareMethod.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/DeclareMethod.cs @@ -1,4 +1,5 @@ namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// Declares a method. See because these classes behave similarly /// @@ -17,7 +18,7 @@ } /// - /// 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 /// /// The verb to add diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/ForChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/ForChunk.cs index c113a6a..e4fb380 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/ForChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/ForChunk.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// A ForChunk is similar to a . It executes a specific number of times. /// @@ -43,4 +44,4 @@ namespace Advanced_Software_Engineering.Verbs.Flow { valueStorage.DecreaseStack(); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IVerbChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IVerbChunk.cs index dec328b..3759ece 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IVerbChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IVerbChunk.cs @@ -1,8 +1,10 @@ namespace Advanced_Software_Engineering.Verbs.Flow { + /// - /// 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. /// public interface IVerbChunk : IVerb { + /// /// Adds a verb to the verb list /// 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 01e7736..5eab894 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/IfChunk.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// A simple If Object /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/MethodChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/MethodChunk.cs index 717e26d..974a753 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/MethodChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/MethodChunk.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Drawing; namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// The method chunk class /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/VerbChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/VerbChunk.cs index ba37d3f..2323df6 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/VerbChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/VerbChunk.cs @@ -1,6 +1,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// A simple VerbChunk. Used for storing and executing a bunch of verbs /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/WhileChunk.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/WhileChunk.cs index e9285a5..924fee2 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/WhileChunk.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Flow/WhileChunk.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering.Verbs.Flow { + /// /// A Chunk that loops over its code /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/DeclareVariable.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/DeclareVariable.cs index 3c18932..80870bc 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/DeclareVariable.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/DeclareVariable.cs @@ -2,6 +2,7 @@ using System; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// Declares a variable /// @@ -48,8 +49,9 @@ namespace Advanced_Software_Engineering.Verbs.Value { return true; } + /// - /// Creates a new Declare variable + /// Creates a new Declare variable /// /// The storage to use /// The assignment diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/IValue.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/IValue.cs index 87028aa..376f6f7 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/IValue.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/IValue.cs @@ -1,10 +1,12 @@ using System.Drawing; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// A value /// public interface IValue { + /// /// The description of the value /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/UpdateVariable.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/UpdateVariable.cs index 5519a38..7ee5fe5 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/UpdateVariable.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/UpdateVariable.cs @@ -1,6 +1,7 @@ using System; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// Used for updating the variables /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueFactory.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueFactory.cs index 5f9fc0b..dffd7e4 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueFactory.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueFactory.cs @@ -3,6 +3,7 @@ using Advanced_Software_Engineering.Verbs.Value.ValueTypes; using System; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// Value factory creates values /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueStorage.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueStorage.cs index b182a10..385240d 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueStorage.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueStorage.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// The storage for all the values /// diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/ExpressionValue.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/ExpressionValue.cs index 96fd0cb..7d720af 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/ExpressionValue.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/ExpressionValue.cs @@ -2,10 +2,12 @@ using System.Drawing; namespace Advanced_Software_Engineering.Verbs.Value { + /// /// Expression values are used when there are two IValues that need to be added or subtracted or anything from each other. /// public class ExpressionValue : IValue { + /// /// An operation denoting addition /// @@ -26,7 +28,6 @@ namespace Advanced_Software_Engineering.Verbs.Value { /// public const int DIVIDE = 3; - private readonly IValue variable1; private readonly IValue variable2; private readonly int operation; diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/VariableValue.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/VariableValue.cs index 2c4712a..438de95 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/VariableValue.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Value/ValueTypes/VariableValue.cs @@ -2,6 +2,7 @@ using System.Drawing; namespace Advanced_Software_Engineering.Verbs.Value.ValueTypes { + /// /// Variable value is responsible for setting up values for to then update ///