Fixed a few javadoc issues.

main
fjc40 9 years ago
parent b247244665
commit a32775eab6

@ -123,6 +123,7 @@ public class RaceController extends Controller {
* Currently uses an example racecourse * Currently uses an example racecourse
* *
* @param visualiserInput input from network * @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) { public void startRace(VisualiserInput visualiserInput, RaceClock raceClock) {
StreamedRace newRace = new StreamedRace(visualiserInput, this); StreamedRace newRace = new StreamedRace(visualiserInput, this);
@ -245,4 +246,4 @@ public class RaceController extends Controller {
} }
}); });
} }
} }

@ -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. * @return Map of boat locations.
*/ */
public Map<Integer, BoatLocation> getBoatLocationMap() { public Map<Integer, BoatLocation> 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. * @return Map of boat statuses.
*/ */
public Map<Integer, BoatStatus> getBoatStatusMap() { public Map<Integer, BoatStatus> 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. * @return Map of mark roundings.
*/ */
public Map<Integer, MarkRounding> getMarkRoundingMap() { public Map<Integer, MarkRounding> getMarkRoundingMap() {

Loading…
Cancel
Save