From a32775eab6844f938754987d01c3d160e0a3c0b5 Mon Sep 17 00:00:00 2001 From: fjc40 Date: Mon, 8 May 2017 10:59:13 +1200 Subject: [PATCH] Fixed a few javadoc issues. --- .../src/main/java/seng302/Controllers/RaceController.java | 3 ++- visualiser/src/main/java/seng302/VisualiserInput.java | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/visualiser/src/main/java/seng302/Controllers/RaceController.java b/visualiser/src/main/java/seng302/Controllers/RaceController.java index 573fb204..2a489c0f 100644 --- a/visualiser/src/main/java/seng302/Controllers/RaceController.java +++ b/visualiser/src/main/java/seng302/Controllers/RaceController.java @@ -123,6 +123,7 @@ public class RaceController extends Controller { * Currently uses an example racecourse * * @param visualiserInput input from network + * @param raceClock The RaceClock to use for the race's countdown/elapsed duration + timezone. */ public void startRace(VisualiserInput visualiserInput, RaceClock raceClock) { StreamedRace newRace = new StreamedRace(visualiserInput, this); @@ -245,4 +246,4 @@ public class RaceController extends Controller { } }); } -} \ No newline at end of file +} diff --git a/visualiser/src/main/java/seng302/VisualiserInput.java b/visualiser/src/main/java/seng302/VisualiserInput.java index b7caa695..34e712bc 100644 --- a/visualiser/src/main/java/seng302/VisualiserInput.java +++ b/visualiser/src/main/java/seng302/VisualiserInput.java @@ -109,7 +109,7 @@ public class VisualiserInput implements Runnable { } /** - * Returns the boat locations map. Maps between Integer (Boat ID) -> BoatLocation. + * Returns the boat locations map. Maps from Integer (Boat ID) to BoatLocation. * @return Map of boat locations. */ public Map getBoatLocationMap() { @@ -125,7 +125,7 @@ public class VisualiserInput implements Runnable { } /** - * Returns the boat statuses map. Maps between Integer (Boat ID) -> BoatStatus. + * Returns the boat statuses map. Maps from Integer (Boat ID) to BoatStatus. * @return Map of boat statuses. */ public Map getBoatStatusMap() { @@ -150,7 +150,7 @@ public class VisualiserInput implements Runnable { /** - * Returns the mark roundings map. Maps between Integer (Boat ID) -> MarkRounding. + * Returns the mark roundings map. Maps from Integer (Boat ID) to MarkRounding. * @return Map of mark roundings. */ public Map getMarkRoundingMap() {