From 8c7345a30def05616b90c4f5ba6823eff15c8a49 Mon Sep 17 00:00:00 2001 From: cbt24 Date: Thu, 7 Sep 2017 17:01:47 +1200 Subject: [PATCH] Documented command classes #story[1196] --- .../java/mock/model/commandFactory/CollisionCommand.java | 7 ++++++- .../main/java/mock/model/commandFactory/WindCommand.java | 8 +++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/racevisionGame/src/main/java/mock/model/commandFactory/CollisionCommand.java b/racevisionGame/src/main/java/mock/model/commandFactory/CollisionCommand.java index 3314c402..b2fed2ac 100644 --- a/racevisionGame/src/main/java/mock/model/commandFactory/CollisionCommand.java +++ b/racevisionGame/src/main/java/mock/model/commandFactory/CollisionCommand.java @@ -8,13 +8,18 @@ import shared.model.GPSCoordinate; import java.util.Observable; /** - * Created by cbt24 on 7/09/17. + * Command class for collisions */ public class CollisionCommand extends ObserverCommand { private GPSCoordinate startingPosition; private Azimuth azimuth; private double distance; + /** + * Constructor for class + * @param race race context + * @param boat boat controlled by command + */ public CollisionCommand(MockRace race, MockBoat boat) { super(race, boat); } diff --git a/racevisionGame/src/main/java/mock/model/commandFactory/WindCommand.java b/racevisionGame/src/main/java/mock/model/commandFactory/WindCommand.java index 138ccff0..a429b8c4 100644 --- a/racevisionGame/src/main/java/mock/model/commandFactory/WindCommand.java +++ b/racevisionGame/src/main/java/mock/model/commandFactory/WindCommand.java @@ -7,11 +7,17 @@ import shared.model.Bearing; import java.util.Observable; /** - * Created by connortaylorbrown on 4/08/17. + * Command class for upwind and downwind controls */ public class WindCommand extends ObserverCommand { private int direction; + /** + * Constructor for class + * @param race race context + * @param boat boat controlled by command + * @param upwind if true, downwind if false + */ public WindCommand(MockRace race, MockBoat boat, boolean upwind) { super(race, boat); this.direction = upwind? -1 : 1;