Documented Drawer

This commit is contained in:
Lukasz Baldyga committed 2020-12-04 16:17:00 +00:00
1 parent 7d9b53f80c
commit 12b889a3e4
2 files changed
+17 -1

No files matched your search

@@ -1,4 +1,4 @@
[*.cs] [*.cs]
# CS1591: Missing XML comment for publicly visible type or member # CS1591: Missing XML comment for publicly visible type or member
dotnet_diagnostic.CS1591.severity = suggestion dotnet_diagnostic.CS1591.severity = warning
@@ -12,9 +12,25 @@ 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>
/// Value storage is used for storing all of the variables and their IValues. See <see cref="ValueStorage"/> and see <see cref="IValue"/>
/// </summary>
private readonly ValueStorage valueStorage = new ValueStorage(); private readonly ValueStorage valueStorage = new ValueStorage();
/// <summary>
/// List of verbChunks used to create for loops, if statements, while loops and methods.
/// See <see cref="ForChunk"/>, <see cref="IfChunk"/>, <see cref="MethodChunk"/>, <see cref="WhileChunk"/> and <seealso cref="IVerbChunk"/>.
/// </summary>
public List<IVerbChunk> verbChunks = new List<IVerbChunk>(); public List<IVerbChunk> verbChunks = new List<IVerbChunk>();
/// <summary>
/// A veriable that represents wether the last verbchunk is a method. See <see cref="MethodChunk"/>
/// </summary>
public bool verbChunkGeneratingMethod = false; public bool verbChunkGeneratingMethod = false;
/// <summary>
/// A list of methods. See <see cref="MethodChunk"/>
/// </summary>
public Dictionary<string, MethodChunk> Methods = new Dictionary<string, MethodChunk>(); public Dictionary<string, MethodChunk> Methods = new Dictionary<string, MethodChunk>();
/// <summary> /// <summary>