From 4441f441c0390feaf0af6a183d5e690427756edb Mon Sep 17 00:00:00 2001 From: Lukasz Baldyga Date: Tue, 3 Nov 2020 13:05:58 +0000 Subject: [PATCH] Documented Square --- .../Verbs/DrawingVerbs/Square.cs | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs index ad8be6e..bc03f15 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs @@ -5,20 +5,40 @@ using System.Text; using System.Threading.Tasks; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { - class Square : Verb { + /// + /// The Square Verb class + /// + public class Square : Verb { Verb verb; - + /// + /// A new Squre instance. Draws squares using + /// + /// drawer + /// size of the square public Square(Drawer drawer, double scale) { verb = new RegularPolygon(drawer, 4, scale); } + /// + /// A new Squre instance. Draws squares using + /// + /// drawer + /// size of the square + /// rotation offset in degrees public Square(Drawer drawer, double scale, double offset) { verb = new RegularPolygon(drawer, 4, scale, offset); } + /// + /// Draws the regular polygon (square) + /// public void ExecuteVerb() => verb.ExecuteVerb(); + /// + /// Gets description of how it will draw the regular polygon (square) + /// + /// public string GetDescription() => verb.GetDescription(); } }