javadoc fixes.

main
fjc40 8 years ago
parent 19984772c0
commit 61d18f85c5

@ -56,6 +56,7 @@ public class MockRace extends Race {
* @param latestMessages The LatestMessages to send events to. * @param latestMessages The LatestMessages to send events to.
* @param polars The polars table to be used for boat simulation. * @param polars The polars table to be used for boat simulation.
* @param timeScale The timeScale for the race. See {@link Constants#RaceTimeScale}. * @param timeScale The timeScale for the race. See {@link Constants#RaceTimeScale}.
* @param windGenerator The wind generator used for the race.
*/ */
public MockRace(BoatDataSource boatDataSource, RaceDataSource raceDataSource, RegattaDataSource regattaDataSource, LatestMessages latestMessages, Polars polars, int timeScale, WindGenerator windGenerator) { public MockRace(BoatDataSource boatDataSource, RaceDataSource raceDataSource, RegattaDataSource regattaDataSource, LatestMessages latestMessages, Polars polars, int timeScale, WindGenerator windGenerator) {

@ -39,7 +39,7 @@ public class ControllerClient {
/** /**
* Send a keypress to server * Send a keypress to server
* @param key to send * @param key to send
* @throws IOException if socket write fails * @throws InterruptedException If thread is interrupted while writing message to outgoing message queue.
*/ */
public void sendKey(ControlKey key) throws InterruptedException { public void sendKey(ControlKey key) throws InterruptedException {
BoatActionEnum protocolCode = key.getProtocolCode(); BoatActionEnum protocolCode = key.getProtocolCode();

@ -19,9 +19,9 @@ public class MockRaceTest {
* Creates a MockRace for use in testing. * Creates a MockRace for use in testing.
* Has a constant wind generator. * Has a constant wind generator.
* @return MockRace for testing. * @return MockRace for testing.
* @throws InvalidBoatDataException * @throws InvalidBoatDataException If the BoatDataSource cannot be created.
* @throws InvalidRaceDataException * @throws InvalidRaceDataException If the RaceDataSource cannot be created.
* @throws InvalidRegattaDataException * @throws InvalidRegattaDataException If the RegattaDataSource cannot be created.
*/ */
public static MockRace createMockRace() throws InvalidBoatDataException, InvalidRaceDataException, InvalidRegattaDataException { public static MockRace createMockRace() throws InvalidBoatDataException, InvalidRaceDataException, InvalidRegattaDataException {

Loading…
Cancel
Save