Documented Drawer

Advanced Software Engineering/Advanced Software Engineering/Drawer.cs

@@ -7,51 +7,127 @@ using System.Text;
 using System.Threading.Tasks;
 
 namespace Advanced_Software_Engineering {
+    /// <summary>
+    /// The drawer is responsible for drawing on the graphics object.
+    /// </summary>
     public class Drawer {
+        /// <summary>
+        /// The starting color of the pen / brush
+        /// </summary>
         protected static Color defaultColor = Color.Black;
+        /// <summary>
+        /// The deafult width of the pen
+        /// </summary>
         protected static float defaultWidth = 1f;
+        /// <summary>
+        /// Weather enclosed spaces will have fill.
+        /// </summary>
         protected bool fill = false;
 
-
+        /// <summary>
+        /// The Brush object
+        /// </summary>
         protected Brush brush;
+        /// <summary>
+        /// The Pen object
+        /// </summary>
         protected Pen pen;
 
-
+        /// <summary>
+        /// The current position of the pen.
+        /// </summary>
         protected Point penPosition;
+        /// <summary>
+        /// The graphics object
+        /// </summary>
         protected Graphics graphics;
 
+        /// <summary>
+        /// Creates a new drawer object.
+        /// </summary>
+        /// <param name="graphics">Graphics context</param>
         public Drawer(Graphics graphics) {
             this.graphics = graphics;
             ResetDrawer();
         }
 
+        /// <summary>
+        /// Restart the drawer.
+        /// </summary>
         public void ResetDrawer() {
             graphics.Clear(Color.White);
             penPosition = new Point(0, 0);
             pen = new Pen(defaultColor, defaultWidth);
             brush = new SolidBrush(defaultColor);
+            fill = false;
         }
 
+        /// <summary>
+        /// Set thhe graphics context.
+        /// </summary>
+        /// <param name="graphics"></param>
         public void SetGraphics(Graphics graphics) => this.graphics = graphics;
 
+        /// <summary>
+        /// Move the pen to the point.
+        /// </summary>
+        /// <param name="point">Position to move the pen to</param>
         public void MovePen(Point point) => penPosition = point;
+        /// <summary>
+        /// Returns the current pen position
+        /// </summary>
+        /// <returns>The curren pen position</returns>
         public Point GetPenPosition() => new Point(penPosition.X, penPosition.Y);
 
+        /// <summary>
+        /// Get current fill status
+        /// </summary>
+        /// <returns>current fill satus</returns>
         public bool GetFill() => fill;
+        /// <summary>
+        /// Allows the filling of objects.
+        /// </summary>
         public void EnableFill() => fill = false;
+        /// <summary>
+        /// Disables the filling of objects.
+        /// </summary>
         public void DisableFill() => fill = true;
-        public void SetFill(bool down) => fill = down;
+        /// <summary>
+        /// Set the filling of objects
+        /// </summary>
+        /// <param name="fill">Set fill</param>
+        public void SetFill(bool fill) => this.fill = fill;
 
+        /// <summary>
+        /// Set the pen color
+        /// </summary>
+        /// <param name="color">Pen color</param>
         public void SetPenColor(Color color) => pen.Color = color;
+        /// <summary>
+        /// Set the width of the pen
+        /// </summary>
+        /// <param name="width">Pen width</param>
         public void SetPenWidth(float width) => pen.Width = width;
 
+        /// <summary>
+        /// Set fill color
+        /// </summary>
+        /// <param name="color">Fill color</param>
         public void SetFillColor(Color color) => ((SolidBrush)brush).Color = color;
 
+        /// <summary>
+        /// Draws a line from the current pen position to the one specified in the parameter. This also sets the pens new position.
+        /// </summary>
+        /// <param name="point">Draw to point</param>
         public void DrawLine(Point point) {
             graphics.DrawLine(pen, penPosition, point);
             penPosition = point;
         }
 
+        /// <summary>
+        /// Draws multiple lines to multiple points. This doesn't change the pens position.
+        /// </summary>
+        /// <param name="points">Points to draw to</param>
         public void DrawLines(Point[] points) {
             if (points.Length < 2) {
                 throw new Exception("Cannot have less than two points in a line");
@@ -68,21 +144,34 @@ namespace Advanced_Software_Engineering {
             DrawLines(path);
         }
 
-        //Doesn't move pen
+        /// <summary>
+        /// Draws multiple lines to multiple points. This doesn't change the pens position.
+        /// </summary>
+        /// <param name="path">GraphicsPath to draw to</param>
         public void DrawLines(GraphicsPath path) {
             //path.Widen(pen);
             if (fill) graphics.FillPath(brush, path);
             graphics.DrawPath(pen, path);
         }
 
+        /// <summary>
+        /// Draws a circle of a scale ath the pen's position
+        /// </summary>
+        /// <param name="scale">Scale of the circle</param>
         public void DrawCircle(double scale) {
             graphics.DrawEllipse(pen, penPosition.X - (float)(scale), penPosition.Y - (float)(scale), (float)scale * 2, (float)scale * 2);
         }
 
+        /// <summary>
+        /// Clears the canvas
+        /// </summary>
         public void ClearCanvas() {
             graphics.Clear(Color.White);
         }
 
+        /// <summary>
+        /// Draws a single pixel with the pen's color at the pen's position.
+        /// </summary>
         public void DrawDot() {
             graphics.FillRectangle(new SolidBrush(pen.Color), penPosition.X, penPosition.Y, 1, 1);
         }