Filled in javadoc, optimised imports, rearranged code

#refactor #story[16]

src/main/java/seng302/App.java

@@ -11,18 +11,24 @@ import seng302.Controllers.MainController;
 
 import java.io.InputStream;
 
-
-public class App extends Application
-{
+public class App extends Application {
     Stage primaryStage;
     BorderPane mainContainer;
     Scene mainScene;
 
-    public static void main( String[] args )
-    {
+    /**
+     * Entry point for running the programme
+     * @param args
+     */
+    public static void main(String[] args) {
         launch(args);
     }
 
+    /**
+     * Loads and sets up the GUI elements
+     * @param primaryStage
+     * @throws Exception
+     */
     @Override
     public void start(Stage primaryStage) throws Exception {
         this.primaryStage = primaryStage;
@@ -46,6 +52,11 @@ public class App extends Application
         primaryStage.show();
     }
 
+    /**
+     * Loads panes for use in the GUI
+     * @param fxmlName
+     * @throws Exception
+     */
     public void loadPane(String fxmlName) throws Exception {
         FXMLLoader loader = new FXMLLoader();
         InputStream in = getClass().getClassLoader().getResourceAsStream("scenes//" + fxmlName);

src/main/java/seng302/Constants.java

@@ -2,7 +2,6 @@ package seng302;
 
 import javafx.scene.paint.Color;
 import seng302.Model.BoatInRace;
-import seng302.Model.Leg;
 
 /**
  * Constants that are used throughout the program
@@ -10,13 +9,11 @@ import seng302.Model.Leg;
  */
 public class Constants {
 
-    public static final int NMToMetersConversion = 1852; //nautical miles
+    public static final int NMToMetersConversion = 1852; // 1 nautical mile = 1852 meters
 
     public static final GPSCoordinate startLineMarker1 = new GPSCoordinate(32.296577, -64.854304);
     public static final GPSCoordinate startLineMarker2 = new GPSCoordinate(32.293771, -64.855242);
-
     public static final GPSCoordinate mark1 = new GPSCoordinate(32.293039, -64.843983);
-
     public static final GPSCoordinate windwardGate1 = new GPSCoordinate(32.284680, -64.850045);
     public static final GPSCoordinate windwardGate2 = new GPSCoordinate(32.280164, -64.847591);
     public static final GPSCoordinate leewardGate1 = new GPSCoordinate(32.309693, -64.835249);
@@ -32,5 +29,4 @@ public class Constants {
                     new BoatInRace("Artemis Racing", 22.5, Color.DARKOLIVEGREEN, "ART"),
                     new BoatInRace("Emirates Team New Zealand", 62, Color.LIMEGREEN, "ENZ")};
 
-    //public static final Leg bermudaCourseStartToMark1 = new Leg(0, , new )
 }

src/main/java/seng302/Controllers/Controller.java

@@ -15,6 +15,7 @@ public abstract class Controller implements Initializable{
 
     /**
      * Sets the parent of the application
+     *
      * @param parent
      */
     public void setParent(App parent) {
@@ -23,6 +24,7 @@ public abstract class Controller implements Initializable{
 
     /**
      * Sets the loads a pane into the parent.
+     *
      * @param fxmlName
      * @throws Exception
      */
@@ -32,6 +34,7 @@ public abstract class Controller implements Initializable{
 
     /**
      * Initialisation class that is run on start up.
+     *
      * @param location
      * @param resources
      */

src/main/java/seng302/Controllers/MainController.java

@@ -1,7 +1,5 @@
 package seng302.Controllers;
 
-import javafx.fxml.Initializable;
-
 import java.net.URL;
 import java.util.ResourceBundle;
 
@@ -12,6 +10,7 @@ public class MainController extends Controller {
 
     /**
      * Main Controller for the applications will house the menu and the displayed pane.
+     *
      * @param location
      * @param resources
      */

src/main/java/seng302/Controllers/RaceController.java

@@ -3,28 +3,18 @@ package seng302.Controllers;
 
 import javafx.beans.property.ReadOnlyObjectWrapper;
 import javafx.beans.value.ObservableValue;
-import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
-import javafx.scene.canvas.GraphicsContext;
 import javafx.scene.control.Label;
 import javafx.scene.control.SplitPane;
 import javafx.scene.control.TableColumn;
 import javafx.scene.control.TableView;
-import javafx.scene.control.cell.PropertyValueFactory;
 import javafx.scene.layout.AnchorPane;
 import javafx.scene.layout.GridPane;
-import javafx.scene.paint.Color;
 import javafx.util.Callback;
-import org.geotools.referencing.GeodeticCalculator;
 import seng302.Constants;
-import seng302.GPSCoordinate;
-import seng302.Model.ResizableRaceCanvas;
 import seng302.Model.*;
-import seng302.RaceMap;
 
-import java.awt.event.ActionEvent;
-import java.awt.geom.Point2D;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.ResourceBundle;
@@ -33,20 +23,19 @@ import java.util.ResourceBundle;
  * Created by fwy13 on 15/03/2017.
  */
 public class RaceController extends Controller {
+
+    ResizableRaceCanvas raceMap;
     @FXML
     AnchorPane canvasBase;
 
     @FXML
     GridPane startScreen;
+    @FXML
+    SplitPane ongoingRacePane;
 
-    ResizableRaceCanvas raceMap;
 
     @FXML
     Label timer;
-
-    @FXML
-    SplitPane ongoingRacePane;
-
     @FXML
     TableView<BoatInRace> boatInfoTable;
     @FXML
@@ -59,11 +48,11 @@ public class RaceController extends Controller{
     TableColumn<BoatInRace, String> boatSpeedColumn;
 
     /**
-     * updates the ResizableRaceCanvas (raceMap) with most recent data
+     * Updates the ResizableRaceCanvas (raceMap) with most recent data
+     *
      * @param boats boats that are to be displayed in the race
      * @see ResizableRaceCanvas
      */
-
     public void updateMap(ObservableList<BoatInRace> boats) {
         BoatInRace[] boatInRaces = new BoatInRace[boats.size()];
         raceMap.setBoats(boats.toArray(boatInRaces));
@@ -72,6 +61,7 @@ public class RaceController extends Controller{
 
     /**
      * Updates the array listened by the TableView (boatInfoTable) that displays the boat information.
+     *
      * @param race Race to listen to.
      */
     public void setInfoTable(Race race) {
@@ -89,23 +79,38 @@ public class RaceController extends Controller{
         });
     }
 
-
-    @FXML
+    /**
+     * Begins the race with a scale factor of 15
+     */
     public void startRace1Min() {
         startRace(15);
     }
 
-    @FXML
+    /**
+     * Begins the race with a scale factor of 3
+     */
     public void startRace5Min() {
         startRace(3);
     }
 
-    @FXML
+    /**
+     * Begins the race with a scale factor of 1
+     */
     public void startRaceNoScaling() {
         startRace(1);
     }
 
+    @Override
+    public void initialize(URL location, ResourceBundle resources) {
 
+    }
+
+    /**
+     * Initializes and runs the race, based on the user's chosen scale factor
+     * Currently uses an example racecourse
+     *
+     * @param scaleFactor
+     */
     private void startRace(int scaleFactor) {
         BoatInRace[] boats = generateAC35Competitors();
         raceMap = new ResizableRaceCanvas();
@@ -126,15 +131,9 @@ public class RaceController extends Controller{
         (new Thread(race)).start();
     }
 
-    @Override
-    public void initialize(URL location, ResourceBundle resources) {
-
-    }
-
-
-
     /**
-     * Function for the Bermuda Race.
+     * Generates an example race course (Bermuda 2017)
+     *
      * @return legs in the Bermuda Race.
      */
     private ArrayList<Leg> generateBermudaCourseLegs() {
@@ -144,29 +143,33 @@ public class RaceController extends Controller{
         Leg leg3 = new Leg("Leeward Gate to Windward Gate", Constants.leewardGate1, Constants.windwardGate1, 2);
         Leg leg4 = new Leg("Windward Gate to Leeward Gate", Constants.windwardGate1, Constants.leewardGate1, 3);
         Leg leg5 = new Leg("Leeward Gate to Finish", Constants.leewardGate1, Constants.finishLineMarker1, 4);
-        legs.add(leg1); legs.add(leg2); legs.add(leg3); legs.add(leg4); legs.add(leg5);
+        legs.add(leg1);
+        legs.add(leg2);
+        legs.add(leg3);
+        legs.add(leg4);
+        legs.add(leg5);
         return legs;
     }
 
+    /**
+     * Generates an example list of competitors (Official AC35 competitors)
+     * @return List of official AC35 competing boats
+     */
     private BoatInRace[] generateAC35Competitors() {
 
         BoatInRace[] boats = new BoatInRace[6];
 
-
         int i = 0;
         for (BoatInRace boat : Constants.OFFICIAL_AC35_COMPETITORS) {
             boat.setCurrentPosition(Constants.startLineMarker1);
             boats[i] = boat;
             i++;
         }
-
         return boats;
-
     }
 
     public void setTimer(String time) {
         timer.setText(time);
     }
 
-
 }

src/main/java/seng302/GPSCoordinate.java

@@ -11,13 +11,18 @@ public class GPSCoordinate {
 
     /**
      * Constructor Method
+     *
      * @param latitude  latitude the coordinate is located at.
      * @param longitude Longitude that the coordinate is located at.
      */
-    public GPSCoordinate(double latitude, double longitude) { this.latitude = latitude; this.longitude = longitude; }
+    public GPSCoordinate(double latitude, double longitude) {
+        this.latitude = latitude;
+        this.longitude = longitude;
+    }
 
     /**
      * Gets the Latitude that the Coordinate is at.
+     *
      * @return Returns the latitude of the Coordinate.
      */
     public double getLatitude() {
@@ -26,12 +31,16 @@ public class GPSCoordinate {
 
     /**
      * Gets the Longitude that the Coordinate is at.
+     *
      * @return Returns the longitude of the Coordinate.
      */
-    public double getLongitude() { return longitude; }
+    public double getLongitude() {
+        return longitude;
+    }
 
     /**
      * To String method of the Coordinate in the form Latitude: $f, Longitude: $f.
+     *
      * @return A String representation of the GPSCoordinate Class.
      */
     public String toString() {

src/main/java/seng302/GraphCoordinate.java

@@ -10,13 +10,18 @@ public class GraphCoordinate {
 
     /**
      * Constructor method.
+     *
      * @param x X coordinate.
      * @param y Y coordinate.
      */
-    public GraphCoordinate(int x, int y) { this.x = x; this.y = y; }
+    public GraphCoordinate(int x, int y) {
+        this.x = x;
+        this.y = y;
+    }
 
     /**
      * Returns the X coordinate.
+     *
      * @return x axis Coordinate.
      */
     public int getX() {
@@ -25,6 +30,7 @@ public class GraphCoordinate {
 
     /**
      * Returns the Y coordinate.
+     *
      * @return y axis Coordinate.
      */
     public int getY() {

src/main/java/seng302/Model/Boat.java

@@ -1,24 +1,21 @@
 package seng302.Model;
 
-import javafx.beans.property.DoubleProperty;
-import javafx.beans.property.SimpleDoubleProperty;
 import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 
-import java.util.ArrayList;
-
 /**
  * Created by fwy13 on 3/03/17.
  */
 public class Boat {
-    private StringProperty name;
 
+    private StringProperty name;
     private double velocity;
     private StringProperty velocityProp;
     private String abbrev;
 
     /**
      * Boat initialiser which keeps all of the information of the boat.
+     *
      * @param name     Name of the Boat.
      * @param velocity Speed in m/s that the boat travels at.
      */
@@ -30,20 +27,22 @@ public class Boat {
     }
 
     /**
-     *
-     * @return The name of the boat
+     * @return Name of the boat
      */
     public StringProperty getName() {
         return name;
     }
 
+    /**
+     * Sets the boat name
+     * @param name
+     */
     public void setName(String name) {
         this.name.setValue(name);
     }
 
     /**
-     *
-     * @return returns the speed of the boat.
+     * @return Speed of the boat.
      */
     public double getVelocity() {
         return velocity;
@@ -51,17 +50,25 @@ public class Boat {
 
 
     /**
-     *
-     * @return The Name of the boat.
+     * Print method prints the name of the boat
+     * @return Name of the boat.
      */
     public String toString() {
         return getName().toString();
     }
 
+    /**
+     * @return Velocity String Property of the boat
+     */
     public StringProperty getVelocityProp() {
         return velocityProp;
     }
 
-    public String getAbbrev() { return abbrev; }
+    /**
+     * @return Abbreviation of the boat
+     */
+    public String getAbbrev() {
+        return abbrev;
+    }
 
 }

src/main/java/seng302/Model/BoatInRace.java

@@ -7,7 +7,6 @@ import org.geotools.referencing.GeodeticCalculator;
 import seng302.GPSCoordinate;
 
 
-
 /**
  * Boat in the Race extends Boat.
  * Created by esa46 on 15/03/17.
@@ -25,6 +24,7 @@ public class BoatInRace extends Boat {
 
     /**
      * Constructor method.
+     *
      * @param name     Name of the boat.
      * @param velocity Speed that the boat travels.
      * @param colour   Colour the boat will be displayed as on the map
@@ -35,16 +35,60 @@ public class BoatInRace extends Boat {
         currentLegName = new SimpleStringProperty("");
     }
 
+    /**
+     * Calculates the azimuth of the travel via map coordinates of the raceMarkers
+     *
+     * @return the direction that the boat is heading towards in degrees (-180 to 180).
+     */
+    public double calculateAzimuth() {
+
+        GeodeticCalculator calc = new GeodeticCalculator();
+        calc.setStartingGeographicPoint(currentLeg.getStartGraphCoordinate().getLongitude(), currentLeg.getStartGraphCoordinate().getLatitude());
+        calc.setDestinationGeographicPoint(currentLeg.getEndGraphCoordinate().getLongitude(), currentLeg.getEndGraphCoordinate().getLatitude());
+
+        return calc.getAzimuth();
+    }
 
+    /**
+     * Converts an azimuth to a bearing
+     *
+     * @param azimuth azimuth value to be converted
+     * @return the bearings in degrees (0 to 360).
+     */
+    public static double calculateHeading(double azimuth) {
+        if (azimuth >= 0) {
+            return azimuth;
+        } else {
+            return azimuth + 360;
+        }
+    }
+
+    /**
+     * Calculates the bearing of the travel via map coordinates of the raceMarkers
+     *
+     * @return the direction that the boat is heading towards in degrees (0 to 360).
+     */
+    public double calculateHeading() {
+        double azimuth = this.calculateAzimuth();
+        return calculateHeading(azimuth);
+    }
+
+    /**
+     * @return Scaled velocity of the boat
+     */
     public double getScaledVelocity() {
         return scaledVelocity;
     }
 
+    /**
+     * Sets the boat's scaled velocity
+     * @param velocity
+     */
     public void setScaledVelocity(double velocity) {
         this.scaledVelocity = velocity;
     }
+
     /**
-     *
      * @return Returns the current position of the boat in a GPSCoordinate Class.
      * @see GPSCoordinate
      */
@@ -53,7 +97,16 @@ public class BoatInRace extends Boat {
     }
 
     /**
+     * Sets the current position on the GPS that the boat.
      *
+     * @param position GPSCoordinate of the position that the boat is currently on.
+     * @see GPSCoordinate
+     */
+    public void setCurrentPosition(GPSCoordinate position) {
+        this.currentPosition = position;
+    }
+
+    /**
      * @return Returns the time that the boat finished the race.
      */
     public long getTimeFinished() {
@@ -61,7 +114,15 @@ public class BoatInRace extends Boat {
     }
 
     /**
+     * Sets the time that the boat finished the race.
      *
+     * @param timeFinished Time the boat finished the race.
+     */
+    public void setTimeFinished(long timeFinished) {
+        this.timeFinished = timeFinished;
+    }
+
+    /**
      * @return Returns the colour of the boat.
      */
     public Color getColour() {
@@ -70,6 +131,7 @@ public class BoatInRace extends Boat {
 
     /**
      * Sets the colour that boat will be shown as when drawn on the ResizableRaceCanvas.
+     *
      * @param colour Colour that the boat is to be set to.
      * @see ResizableRaceCanvas
      */
@@ -77,16 +139,9 @@ public class BoatInRace extends Boat {
         this.colour = colour;
     }
 
-    /**
-     * Sets the time that the boat finished the race.
-     * @param timeFinished Time the boat finished the race.
-     */
-    public void setTimeFinished(long timeFinished) {
-        this.timeFinished = timeFinished;
-    }
-
     /**
      * Gets the current leg that the boat is on.
+     *
      * @return returns the leg the boat is on in a Leg class
      * @see Leg
      */
@@ -95,7 +150,8 @@ public class BoatInRace extends Boat {
     }
 
     /**
-     * Sets the current Leg of that the boat is on.
+     * Sets the boat's current leg.
+     *
      * @param currentLeg Leg class that the boat is currently on.
      * @see Leg
      */
@@ -104,76 +160,44 @@ public class BoatInRace extends Boat {
         this.currentLegName.setValue(currentLeg.getName());
     }
 
+    /**
+     * @return Name of boat's current leg
+     */
     public StringProperty getCurrentLegName() {
         return currentLegName;
     }
 
     /**
      * Gets the distance travelled by the boat in the leg.
+     *
      * @return Returns the value in nautical miles (1.852km) that the boat has traversed.
      */
     public double getDistanceTravelledInLeg() {
         return distanceTravelledInLeg;
     }
 
-    /**
-     * Sets the current position on the GPS that the boat.
-     * @param position GPSCoordinate of the position that the boat is currently on.
-     * @see GPSCoordinate
-     */
-    public void setCurrentPosition(GPSCoordinate position) {
-        this.currentPosition = position;
-    }
-
     /**
      * Sets the distance travelled by the boat in the leg in nautical miles (1.852km)
+     *
      * @param distanceTravelledInLeg Distance travelled by the boat in nautical miles.
      */
     public void setDistanceTravelledInLeg(double distanceTravelledInLeg) {
         this.distanceTravelledInLeg = distanceTravelledInLeg;
     }
 
-    public boolean isFinished() {
-        return this.finished;
-    }
-
-    public void setFinished(boolean bool) {
-        this.finished = bool;
-    }
-
     /**
-     * Calculates the azimuth of the travel via map coordinates of the raceMarkers
-     * @return the direction that the boat is heading towards in degrees (-180 to 180).
+     * @return true if boat has finished, fals eif not
      */
-    public double calculateAzimuth(){
-
-        GeodeticCalculator calc = new GeodeticCalculator();
-        calc.setStartingGeographicPoint(currentLeg.getStartGraphCoordinate().getLongitude(), currentLeg.getStartGraphCoordinate().getLatitude());
-        calc.setDestinationGeographicPoint(currentLeg.getEndGraphCoordinate().getLongitude(), currentLeg.getEndGraphCoordinate().getLatitude());
-
-        return calc.getAzimuth();
+    public boolean isFinished() {
+        return this.finished;
     }
 
     /**
-     * Converts an azimuth to a bearing
-     * @param azimuth azimuth valuye to be converted
-     * @return the bearings in degrees (0 to 360).
+     * Sets whether boat is finished or not
+     * @param bool
      */
-    public static double calculateHeading(double azimuth) {
-        if (azimuth >= 0) {
-            return azimuth;
-        }
-        else {
-            return azimuth + 360;
-        }
+    public void setFinished(boolean bool) {
+        this.finished = bool;
     }
 
-    /**
-     * Calculates the bearing of the travel via map coordinates of the raceMarkers
-     * @return the direction that the boat is heading towards in degrees (0 to 360).
-     */
-    public double calculateHeading(){
-        double azimuth = this.calculateAzimuth();
-        return calculateHeading(azimuth);
-    }
 }

src/main/java/seng302/Model/ConstantVelocityRace.java

@@ -1,12 +1,11 @@
 package seng302.Model;
 
+import org.geotools.referencing.GeodeticCalculator;
 import seng302.Constants;
 import seng302.Controllers.RaceController;
-import java.awt.geom.Point2D;
-
-import org.geotools.referencing.GeodeticCalculator;
 import seng302.GPSCoordinate;
 
+import java.awt.geom.Point2D;
 import java.util.ArrayList;
 
 /**
@@ -15,18 +14,23 @@ import java.util.ArrayList;
 public class ConstantVelocityRace extends Race {
 
     /**
-     * Initialiser for a Race with constant velocity.
-     * @param startingBoats array of boats
-     * @param marks array of RaceMarkers that the boats need to pass in order to finish the course.
-     * @see Boat
-     * @see Leg
+     * Initialiser for a constant velocity race
+     *
+     * @param startingBoats
+     * @param legs
+     * @param controller
+     * @param scaleFactor
      */
-
-    public ConstantVelocityRace(BoatInRace[] startingBoats, ArrayList<Leg> marks, RaceController controller, int scaleFactor) {
-        super(startingBoats, marks, controller, scaleFactor);
+    public ConstantVelocityRace(BoatInRace[] startingBoats, ArrayList<Leg> legs, RaceController controller, int scaleFactor) {
+        super(startingBoats, legs, controller, scaleFactor);
     }
 
 
+    /**
+     * Calculates the distance a boat has travelled and updates its current position according to this value.
+     * @param boat
+     * @param millisecondsElapsed
+     */
     protected void updatePosition(BoatInRace boat, int millisecondsElapsed) {
 
         //distanceTravelled = velocity (nm p hr) * time taken to update loop
@@ -35,30 +39,32 @@ public class ConstantVelocityRace extends Race {
 
         boolean finish = boat.getCurrentLeg().getName().equals("Finish");
         if (!finish) {
+            //update boat's distance travelled
             boat.setDistanceTravelledInLeg(totalDistanceTravelled);
+            //Calculate boat's new position by adding the distance travelled onto the start point of the leg
             boat.setCurrentPosition(calculatePosition(boat.getCurrentLeg().getStartGraphCoordinate(),
                                                                     totalDistanceTravelled, boat.calculateAzimuth()));
         }
     }
 
     /**
-     *
+     * Calculates the boats next GPS position based on its distance travelled and heading
      * @param oldCoordinates    GPS coordinates of the boat's starting position
      * @param distanceTravelled distance in nautical miles
      * @param azimuth           boat's current direction. Value between -180 and 180
-     * @return
+     * @return The boat's new coordinate
      */
     public static GPSCoordinate calculatePosition(GPSCoordinate oldCoordinates, double distanceTravelled, double azimuth) {
 
         //Find new coordinate using current heading and distance
 
         GeodeticCalculator geodeticCalculator = new GeodeticCalculator();
-
+        //Load start point into calculator
         Point2D startPoint = new Point2D.Double(oldCoordinates.getLongitude(), oldCoordinates.getLatitude());
         geodeticCalculator.setStartingGeographicPoint(startPoint);
-
+        //load direction and distance tranvelled into calculator
         geodeticCalculator.setDirection(azimuth, distanceTravelled * Constants.NMToMetersConversion);
-
+        //get new point
         Point2D endPoint = geodeticCalculator.getDestinationGeographicPoint();
 
         return new GPSCoordinate(endPoint.getY(), endPoint.getX());

src/main/java/seng302/Model/Leg.java

@@ -1,10 +1,8 @@
 package seng302.Model;
 
-import org.geotools.referencing.Console;
 import org.geotools.referencing.GeodeticCalculator;
 import seng302.Constants;
 import seng302.GPSCoordinate;
-import seng302.GraphCoordinate;
 
 /**
  * Created by cbt24 on 6/03/17.
@@ -20,6 +18,7 @@ public class Leg {
 
     /**
      * Leg Initialiser
+     *
      * @param name Name of the Leg
      */
     public Leg(String name, GPSCoordinate start, GPSCoordinate end, int number) {
@@ -32,6 +31,7 @@ public class Leg {
 
     /**
      * Construction Method
+     *
      * @param name Name of the Leg
      */
     public Leg(String name, int number) {
@@ -41,6 +41,7 @@ public class Leg {
 
     /**
      * Returns the name of the Leg
+     *
      * @return Returns the name of the Leg
      */
     public String getName() {
@@ -49,6 +50,7 @@ public class Leg {
 
     /**
      * Get the distance in nautical miles
+     *
      * @return Returns the total distance of the leg.
      */
     public double getDistance() {
@@ -57,6 +59,7 @@ public class Leg {
 
     /**
      * Returns the coordinates in GPSCoordinate class of the boats starting coordinate.
+     *
      * @return Returns the coordinate of the start of the leg.
      * @see GPSCoordinate
      */
@@ -66,6 +69,7 @@ public class Leg {
 
     /**
      * Returns the coordinates in a GPSCoordinate class that the boat ends on.
+     *
      * @return Returns the coordinate of the end of the leg.
      * @see GPSCoordinate
      */
@@ -75,6 +79,7 @@ public class Leg {
 
     /**
      * Returns the leg number that the leg exists in the Race
+     *
      * @return Returns the Leg
      * @see Race
      */
@@ -84,11 +89,13 @@ public class Leg {
 
     /**
      * Calculates the distance that the legs are in nautical miles (1.852 km).
+     *
      * @return Returns the leg distance.
      */
     private double calculateDistance() {
 
         GeodeticCalculator calc = new GeodeticCalculator();
+        //Load start and end of leg
         calc.setStartingGeographicPoint(startGPSCoordinate.getLongitude(), startGPSCoordinate.getLatitude());
         calc.setDestinationGeographicPoint(endGPSCoordinate.getLongitude(), endGPSCoordinate.getLatitude());
         return calc.getOrthodromicDistance() / Constants.NMToMetersConversion;

src/main/java/seng302/Model/Race.java

@@ -6,7 +6,7 @@ import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import seng302.Controllers.RaceController;
 
-import java.util.*;
+import java.util.ArrayList;
 
 /**
  * Parent class for races
@@ -28,6 +28,7 @@ public abstract class Race implements Runnable {
 
     /**
      * Initailiser for Race
+     *
      * @param boats Takes in an array of boats that are participating in the race.
      * @param legs  Number of marks in order that the boats pass in order to complete the race.
      */
@@ -49,6 +50,7 @@ public abstract class Race implements Runnable {
 
     /**
      * Constructor for Race class
+     *
      * @param boats boats participating in the race.
      * @param legs  legs that there are in the race.
      */
@@ -82,7 +84,8 @@ public abstract class Race implements Runnable {
     }
 
     /**
-     * Set up the state in waiting for the race starts.
+     * Initialises the boats,
+     * Sets the boats' current to the first leg in the race
      */
     private void preRace() {
         //show the boats participating.
@@ -94,6 +97,9 @@ public abstract class Race implements Runnable {
     }
 
 
+    /**
+     * Prerace timer showing time until the race will begin, as a negative value
+     */
     protected void countdownTimer() {
         long currentTime = System.currentTimeMillis();
         long startTime = currentTime + PRERACE_TIME;
@@ -128,6 +134,10 @@ public abstract class Race implements Runnable {
         }
     }
 
+    /**
+     * Takes elapsed time in minutes and scales it, converts to hh:mm:ss format
+     * @return String formatted race time, scaled
+     */
     protected String calcTimer() {
         long minutes;
         long currentTimeInSeconds;
@@ -143,9 +153,15 @@ public abstract class Race implements Runnable {
         return String.format("Race clock: %02d:%02d:%02d", hours, minutes, remainingSeconds);
     }
 
+    /**
+     * Updates the GUI race clock
+     * @param time
+     */
     protected void updateTime(String time) {
 
-        Platform.runLater(() -> {controller.setTimer(time);});
+        Platform.runLater(() -> {
+            controller.setTimer(time);
+        });
     }
 
     /**
@@ -155,11 +171,9 @@ public abstract class Race implements Runnable {
     private void simulateRace() {
 
         long timeRaceStarted = System.currentTimeMillis();
-
         long timeLoopStarted;
         long timeLoopEnded;
 
-
         while (boatsFinished < startingBoats.size()) {
             timeLoopStarted = System.currentTimeMillis();
             totalTimeElapsed = System.currentTimeMillis() - timeRaceStarted;
@@ -185,13 +199,13 @@ public abstract class Race implements Runnable {
 
     /**
      * Checks the position of the boat, this updates the boats current position.
+     *
      * @param boat        Boat that the postion is to be updated for.
      * @param timeElapsed Time that has elapse since the start of the the race.
      * @see BoatInRace
      */
     protected void checkPosition(BoatInRace boat, long timeElapsed) {
         if (boat.getDistanceTravelledInLeg() > boat.getCurrentLeg().getDistance()) {
-//            updateController();
             //boat has passed onto new leg
             if (boat.getCurrentLeg().getName().equals("Finish")) {
                 //boat has finished
@@ -199,12 +213,15 @@ public abstract class Race implements Runnable {
                 boat.setFinished(true);
                 boat.setTimeFinished(timeElapsed);
             } else {
+                //Calculate how much the boat overshot the marker by
                 boat.setDistanceTravelledInLeg(boat.getDistanceTravelledInLeg() - boat.getCurrentLeg().getDistance());
+                //Move boat on to next leg
                 Leg nextLeg = legs.get(boat.getCurrentLeg().getLegNumber() + 1);
-
                 boat.setCurrentLeg(nextLeg);
+                //Add overshoot distance into the distance travelled for the next leg
                 boat.setDistanceTravelledInLeg(boat.getDistanceTravelledInLeg());
             }
+            //Update the boat display table in the GUI to reflect the leg change
             FXCollections.sort(startingBoats, (a, b) -> b.getCurrentLeg().getLegNumber() - a.getCurrentLeg().getLegNumber());
         }
     }
@@ -218,6 +235,7 @@ public abstract class Race implements Runnable {
 
     /**
      * Returns the boats that have started the race.
+     *
      * @return ObservableList of BoatInRace class that participated in the race.
      * @see ObservableList
      * @see BoatInRace
@@ -226,12 +244,12 @@ public abstract class Race implements Runnable {
         return startingBoats;
     }
 
+
     /**
-     * This function is a function that generates the Race and populates the events list.
-     * Is automatically called by the initialiser function, so that simulateRace() does not return an empty race.
-     * @see Race#simulateRace()
+     * Updates the boat's gps coordinates depending on time elapsed
+     * @param boat
+     * @param millisecondsElapsed
      */
-
     protected abstract void updatePosition(BoatInRace boat, int millisecondsElapsed);
 
 }

src/main/java/seng302/Model/ResizableRaceCanvas.java

@@ -23,6 +23,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Sets the boats that are to be displayed in this race.
+     *
      * @param boats
      */
     public void setBoats(BoatInRace[] boats) {
@@ -46,6 +47,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Sets the RaceMap that the RaceCanvas is to be displaying for.
+     *
      * @param map
      */
     public void setMap(RaceMap map) {
@@ -54,6 +56,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Displays the mark of a race as a circle.
+     *
      * @param graphCoordinate Latitude and Logintude in GraphCoordinate that it is to be displayed as.
      * @param paint           Colour the mark is to be coloured.
      * @see GraphCoordinate
@@ -67,6 +70,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Displays a line on the map with rectangles on the starting and ending point of the line.
+     *
      * @param graphCoordinateA Starting Point of the line in GraphCoordinate.
      * @param graphCoordinateB End Point of the line in GraphCoordinate.
      * @param paint            Colour the line is to coloured.
@@ -84,6 +88,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Display a point on the Canvas
+     *
      * @param graphCoordinate Coordinate that the point is to be displayed at.
      * @param paint           Colour that the boat is to be coloured.
      * @see GraphCoordinate
@@ -97,6 +102,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Displays an arrow on the Canvas
+     *
      * @param coordinate Coordinate that the arrow is to be displayed at.
      * @param angle      Angle that the arrow is to be facing in degrees 0 degrees = North (Up).
      * @see GraphCoordinate
@@ -112,6 +118,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Rotates things on the canvas Note: this must be called in between gc.save() and gc.restore() else they will rotate everything
+     *
      * @param angle Bearing angle to rotate at in degrees
      * @param px    Pivot point x of rotation.
      * @param py    Pivot point y of rotation.
@@ -123,6 +130,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Display given name and speed of boat at a graph coordinate
+     *
      * @param name       name of the boat
      * @param speed      speed of the boat
      * @param coordinate coordinate the text appears
@@ -185,6 +193,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Draws a boat at a certain GPSCoordinate
+     *
      * @param colour         Colour to colour boat.
      * @param gpsCoordinates GPScoordinate that the boat is to be drawn at.
      * @see GPSCoordinate
@@ -198,6 +207,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Set the Canvas to resizable.
+     *
      * @return That the Canvas is resizable.
      */
     @Override
@@ -207,6 +217,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Returns the preferred width of the Canvas
+     *
      * @param width
      * @return Returns the width of the Canvas
      */
@@ -217,6 +228,7 @@ public class ResizableRaceCanvas extends Canvas {
 
     /**
      * Returns the preferred height of the Canvas
+     *
      * @param height
      * @return Returns the height of the Canvas
      */

src/main/java/seng302/RaceMap.java

@@ -8,7 +8,8 @@ public class RaceMap {
     private int width, height;
 
     /**
-     * Contructor Method.
+     * Constructor Method.
+     *
      * @param x1     Longitude of the top left point.
      * @param y1     Latitude of the top left point.
      * @param x2     Longitude of the top right point.
@@ -17,11 +18,17 @@ public class RaceMap {
      * @param height height that the Canvas the race is to be drawn on is.
      */
     public RaceMap(double y1, double x1, double y2, double x2, int height, int width) {
-        this.x1 = x1; this.x2 = x2; this.y1 = y1; this.y2 = y2; this.width = width; this.height = height;
+        this.x1 = x1;
+        this.x2 = x2;
+        this.y1 = y1;
+        this.y2 = y2;
+        this.width = width;
+        this.height = height;
     }
 
     /**
      * Converts GPS coordinates to coordinates for container
+     *
      * @param lat GPS latitude
      * @param lon GPS longitude
      * @return GraphCoordinate (pair of doubles)
@@ -34,6 +41,7 @@ public class RaceMap {
 
     /**
      * Converts the GPS Coordinate to GraphCoordinates
+     *
      * @param coordinate GPSCoordinate representation of Latitude and Longitude.
      * @return GraphCoordinate that the GPS is coordinates are to be displayed on the map.
      * @see GraphCoordinate

src/main/resources/scenes/mainpane.fxml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 
-<?import javafx.scene.layout.*?>
-
-
-<BorderPane fx:id="mainPane" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1" fx:controller="seng302.Controllers.MainController" />
+<?import javafx.scene.layout.BorderPane?>
+<BorderPane fx:id="mainPane" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity"
+            prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1"
+            fx:controller="seng302.Controllers.MainController"/>

src/main/resources/scenes/racepane.fxml

@@ -1,14 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<?import javafx.geometry.*?>
-<?import javafx.scene.web.*?>
-<?import javafx.scene.text.*?>
-<?import javafx.scene.canvas.*?>
+<?import javafx.geometry.Insets?>
 <?import javafx.scene.control.*?>
-<?import java.lang.*?>
 <?import javafx.scene.layout.*?>
-
-<AnchorPane xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1" fx:controller="seng302.Controllers.RaceController">
+<?import javafx.scene.text.*?>
+<AnchorPane xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1"
+            fx:controller="seng302.Controllers.RaceController">
     <children>
         <GridPane fx:id="startScreen" prefHeight="600.0" prefWidth="780.0">
             <columnConstraints>
@@ -26,15 +23,20 @@
                 <RowConstraints maxHeight="178.0" minHeight="10.0" prefHeight="178.0" vgrow="SOMETIMES"/>
             </rowConstraints>
             <children>
-            <Text strokeType="OUTSIDE" strokeWidth="0.0" text="Select Your Race Scaling:" GridPane.columnIndex="1" GridPane.rowIndex="1">
+                <Text strokeType="OUTSIDE" strokeWidth="0.0" text="Select Your Race Scaling:" GridPane.columnIndex="1"
+                      GridPane.rowIndex="1">
                     <font>
                         <Font size="23.0"/>
                     </font>
                 </Text>
-            <Button mnemonicParsing="false" onAction="#startRace1Min" text="15x faster" GridPane.columnIndex="1" GridPane.rowIndex="2" />
-            <Button mnemonicParsing="false" onAction="#startRaceNoScaling" text="No scaling" GridPane.columnIndex="3" GridPane.rowIndex="2" />
-            <Button mnemonicParsing="false" onAction="#startRace5Min" text="3x faster" GridPane.columnIndex="2" GridPane.rowIndex="2" />
-            <Label alignment="CENTER" text="Race will take ~1 minute" GridPane.columnIndex="1" GridPane.rowIndex="3">
+                <Button mnemonicParsing="false" onAction="#startRace1Min" text="15x faster" GridPane.columnIndex="1"
+                        GridPane.rowIndex="2"/>
+                <Button mnemonicParsing="false" onAction="#startRaceNoScaling" text="No scaling"
+                        GridPane.columnIndex="3" GridPane.rowIndex="2"/>
+                <Button mnemonicParsing="false" onAction="#startRace5Min" text="3x faster" GridPane.columnIndex="2"
+                        GridPane.rowIndex="2"/>
+                <Label alignment="CENTER" text="Race will take ~1 minute" GridPane.columnIndex="1"
+                       GridPane.rowIndex="3">
                     <opaqueInsets>
                         <Insets/>
                     </opaqueInsets>
@@ -42,7 +44,8 @@
                         <Font size="10.0"/>
                     </font>
                 </Label>
-            <Label alignment="CENTER" layoutX="99.0" layoutY="407.0" text="Race will take ~5 minutes" GridPane.columnIndex="2" GridPane.rowIndex="3">
+                <Label alignment="CENTER" layoutX="99.0" layoutY="407.0" text="Race will take ~5 minutes"
+                       GridPane.columnIndex="2" GridPane.rowIndex="3">
                     <font>
                         <Font size="10.0"/>
                     </font>
@@ -50,7 +53,8 @@
                         <Insets/>
                     </opaqueInsets>
                 </Label>
-            <Label alignment="CENTER" layoutX="279.0" layoutY="407.0" text="Race will take ~15 minutes" GridPane.columnIndex="3" GridPane.rowIndex="3">
+                <Label alignment="CENTER" layoutX="279.0" layoutY="407.0" text="Race will take ~15 minutes"
+                       GridPane.columnIndex="3" GridPane.rowIndex="3">
                     <font>
                         <Font size="10.0"/>
                     </font>
@@ -60,16 +64,21 @@
                 </Label>
             </children>
         </GridPane>
-      <SplitPane fx:id="ongoingRacePane" dividerPositions="0.70" visible="false" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
+        <SplitPane fx:id="ongoingRacePane" dividerPositions="0.70" visible="false" AnchorPane.bottomAnchor="0.0"
+                   AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
             <items>
                 <AnchorPane fx:id="canvasBase" prefHeight="581.0" prefWidth="537.0">
                     <children>
-                  <Label fx:id="timer" layoutX="45.0" layoutY="146.0" text="0:0" AnchorPane.bottomAnchor="0.0" AnchorPane.rightAnchor="0.0" />
+                        <Label fx:id="timer" layoutX="45.0" layoutY="146.0" text="0:0" AnchorPane.bottomAnchor="0.0"
+                               AnchorPane.rightAnchor="0.0"/>
                     </children>
                 </AnchorPane>
-          <AnchorPane layoutX="450.0" minHeight="0.0" minWidth="0.0" prefHeight="160.0" prefWidth="200.0" GridPane.columnIndex="1">
+                <AnchorPane layoutX="450.0" minHeight="0.0" minWidth="0.0" prefHeight="160.0" prefWidth="200.0"
+                            GridPane.columnIndex="1">
                     <children>
-                  <TableView fx:id="boatInfoTable" layoutX="-2.0" prefHeight="600.0" prefWidth="264.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="-2.0" AnchorPane.rightAnchor="-62.0" AnchorPane.topAnchor="0.0">
+                        <TableView fx:id="boatInfoTable" layoutX="-2.0" prefHeight="600.0" prefWidth="264.0"
+                                   AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="-2.0"
+                                   AnchorPane.rightAnchor="-62.0" AnchorPane.topAnchor="0.0">
                             <columns>
                                 <TableColumn fx:id="boatPlacingColumn" prefWidth="50.0" text="Place"/>
                                 <TableColumn fx:id="boatTeamColumn" prefWidth="100.0" text="Team"/>

src/test/java/seng302/AppTest.java

@@ -1,16 +0,0 @@
-package seng302;
-
-import org.junit.Test;
-import static org.junit.Assert.assertTrue;
-
-/**
- * Unit test for simple App.
- */
-public class AppTest 
-{
-    @Test
-    public void testApp()
-    {
-        assertTrue( true );
-    }
-}

src/test/java/seng302/Model/BoatInRaceTest.java

@@ -1,7 +1,6 @@
 package seng302.Model;
 
 import javafx.scene.paint.Color;
-import org.junit.Ignore;
 import org.junit.Test;
 import seng302.GPSCoordinate;
 
@@ -14,7 +13,6 @@ import static junit.framework.TestCase.assertTrue;
 public class BoatInRaceTest {
 
 
-
     @Test
     public void calculateDueNorthAzimuthReturns0() {
         BoatInRace boat = new BoatInRace("Test", 1, Color.ALICEBLUE, "tt");

src/test/java/seng302/Model/ConstantVelocityRaceTest.java

@@ -4,11 +4,9 @@ package seng302.Model;
 import javafx.scene.paint.Color;
 import org.geotools.referencing.GeodeticCalculator;
 import org.junit.Test;
-import org.opengis.geometry.coordinate.Geodesic;
 import seng302.Constants;
 import seng302.GPSCoordinate;
 
-import java.awt.geom.Point2D;
 import java.util.ArrayList;
 
 import static org.junit.Assert.assertEquals;
@@ -22,7 +20,6 @@ public class ConstantVelocityRaceTest {
     int ONE_HOUR = 3600000; //1 hour in milliseconds
 
 
-
     @Test
     public void updatePositionChangesDistanceTravelled() {
 

src/test/java/seng302/Model/RaceTest.java

@@ -1,18 +1,11 @@
 package seng302.Model;
 
-import javafx.collections.FXCollections;
-import javafx.collections.ObservableList;
 import javafx.scene.paint.Color;
-import org.junit.Ignore;
 import org.junit.Test;
 import seng302.GPSCoordinate;
-import seng302.Model.BoatInRace;
-import seng302.Model.ConstantVelocityRace;
-import seng302.Model.Leg;
 
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Observable;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;