Code clean up

a
This commit is contained in:
Lukasz Baldyga committed 2020-12-04 18:52:26 +00:00
1 parent 12455d3267
commit 2884bbe8ca
16 files changed
+20 -1

No files matched your search

@@ -12,6 +12,7 @@ namespace Advanced_Software_Engineering {
/// The drawer is responsible for drawing on the graphics object. /// The drawer is responsible for drawing on the graphics object.
/// </summary> /// </summary>
public class Drawer { public class Drawer {
/// <summary> /// <summary>
/// Value storage is used for storing all of the variables and their IValues. See <see cref="ValueStorage"/> and see <see cref="IValue"/> /// Value storage is used for storing all of the variables and their IValues. See <see cref="ValueStorage"/> and see <see cref="IValue"/>
/// </summary> /// </summary>
@@ -1,6 +1,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering { namespace Advanced_Software_Engineering {
/// <summary> /// <summary>
/// This class is a direct replacement to the dictionaries that were returned by <see cref="HelperFunctions.CommandAndParameterParser(string)"/>. /// 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. /// This class provides better intraface to the output.
@@ -1,4 +1,5 @@
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// Declares a method. See <see cref="DrawingVerbs.Actions.NoOp"/> because these classes behave similarly /// Declares a method. See <see cref="DrawingVerbs.Actions.NoOp"/> because these classes behave similarly
/// </summary> /// </summary>
@@ -2,6 +2,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// A ForChunk is similar to a <see cref="WhileChunk"/>. It executes a specific number of times. /// A ForChunk is similar to a <see cref="WhileChunk"/>. It executes a specific number of times.
/// </summary> /// </summary>
@@ -1,8 +1,10 @@
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <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> /// </summary>
public interface IVerbChunk : IVerb { public interface IVerbChunk : IVerb {
/// <summary> /// <summary>
/// Adds a verb to the verb list /// Adds a verb to the verb list
/// </summary> /// </summary>
@@ -2,6 +2,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// A simple If Object /// A simple If Object
/// </summary> /// </summary>
@@ -3,6 +3,7 @@ using System.Collections.Generic;
using System.Drawing; using System.Drawing;
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// The method chunk class /// The method chunk class
/// </summary> /// </summary>
@@ -1,6 +1,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// A simple VerbChunk. Used for storing and executing a bunch of verbs /// A simple VerbChunk. Used for storing and executing a bunch of verbs
/// </summary> /// </summary>
@@ -2,6 +2,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary> /// <summary>
/// A Chunk that loops over its code /// A Chunk that loops over its code
/// </summary> /// </summary>
@@ -2,6 +2,7 @@
using System; using System;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// Declares a variable /// Declares a variable
/// </summary> /// </summary>
@@ -48,6 +49,7 @@ namespace Advanced_Software_Engineering.Verbs.Value {
return true; return true;
} }
/// <summary> /// <summary>
/// Creates a new Declare variable /// Creates a new Declare variable
/// </summary> /// </summary>
@@ -1,10 +1,12 @@
using System.Drawing; using System.Drawing;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// A value /// A value
/// </summary> /// </summary>
public interface IValue { public interface IValue {
/// <summary> /// <summary>
/// The description of the value /// The description of the value
/// </summary> /// </summary>
@@ -1,6 +1,7 @@
using System; using System;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// Used for updating the variables /// Used for updating the variables
/// </summary> /// </summary>
@@ -3,6 +3,7 @@ using Advanced_Software_Engineering.Verbs.Value.ValueTypes;
using System; using System;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// Value factory creates values /// Value factory creates values
/// </summary> /// </summary>
@@ -2,6 +2,7 @@
using System.Collections.Generic; using System.Collections.Generic;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// The storage for all the values /// The storage for all the values
/// </summary> /// </summary>
@@ -2,10 +2,12 @@
using System.Drawing; using System.Drawing;
namespace Advanced_Software_Engineering.Verbs.Value { namespace Advanced_Software_Engineering.Verbs.Value {
/// <summary> /// <summary>
/// Expression values are used when there are two IValues that need to be added or subtracted or anything from each other. /// Expression values are used when there are two IValues that need to be added or subtracted or anything from each other.
/// </summary> /// </summary>
public class ExpressionValue : IValue { public class ExpressionValue : IValue {
/// <summary> /// <summary>
/// An operation denoting addition /// An operation denoting addition
/// </summary> /// </summary>
@@ -26,7 +28,6 @@ namespace Advanced_Software_Engineering.Verbs.Value {
/// </summary> /// </summary>
public const int DIVIDE = 3; public const int DIVIDE = 3;
private readonly IValue variable1; private readonly IValue variable1;
private readonly IValue variable2; private readonly IValue variable2;
private readonly int operation; private readonly int operation;
@@ -2,6 +2,7 @@
using System.Drawing; using System.Drawing;
namespace Advanced_Software_Engineering.Verbs.Value.ValueTypes { namespace Advanced_Software_Engineering.Verbs.Value.ValueTypes {
/// <summary> /// <summary>
/// Variable value is responsible for setting up values for <see cref="UpdateVariable"/> to then update /// Variable value is responsible for setting up values for <see cref="UpdateVariable"/> to then update
/// </summary> /// </summary>