Documented ResetPen

This commit is contained in:
Lukasz Baldyga committed 2020-11-03 13:02:48 +00:00
1 parent ff8bda2f66
commit 243c955b2a
1 file changed
+15 -1
@@ -5,17 +5,31 @@ using System.Text;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { namespace Advanced_Software_Engineering.Verbs.DrawingVerbs {
/// <summary>
/// Setsets the pen to the initial position.
/// </summary>
public class ResetPen : Verb { public class ResetPen : Verb {
Drawer drawer; Drawer drawer;
/// <summary>
/// Creates the ResetPen verb
/// </summary>
/// <param name="drawer">drawer</param>
public ResetPen(Drawer drawer) { public ResetPen(Drawer drawer) {
this.drawer = drawer; this.drawer = drawer;
} }
/// <summary>
/// Moves the pen to 0, 0
/// </summary>
public void ExecuteVerb() => drawer.MovePen(new System.Drawing.Point(0, 0)); public void ExecuteVerb() => drawer.MovePen(new System.Drawing.Point(0, 0));
/// <summary>
/// Gets the description of the command.
/// </summary>
/// <returns>The description of the command</returns>
public string GetDescription() { public string GetDescription() {
return "Moves pen to the start"; return "Moves pen to the start (0, 0)";
} }
} }