From 61d18f85c5354d6f3ac80708a4449b666def8b13 Mon Sep 17 00:00:00 2001 From: fjc40 Date: Thu, 10 Aug 2017 23:57:54 +1200 Subject: [PATCH] javadoc fixes. --- racevisionGame/src/main/java/mock/model/MockRace.java | 1 + .../java/visualiser/gameController/ControllerClient.java | 2 +- racevisionGame/src/test/java/mock/model/MockRaceTest.java | 6 +++--- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/racevisionGame/src/main/java/mock/model/MockRace.java b/racevisionGame/src/main/java/mock/model/MockRace.java index 94fc8792..2f23712f 100644 --- a/racevisionGame/src/main/java/mock/model/MockRace.java +++ b/racevisionGame/src/main/java/mock/model/MockRace.java @@ -56,6 +56,7 @@ public class MockRace extends Race { * @param latestMessages The LatestMessages to send events to. * @param polars The polars table to be used for boat simulation. * @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) { diff --git a/racevisionGame/src/main/java/visualiser/gameController/ControllerClient.java b/racevisionGame/src/main/java/visualiser/gameController/ControllerClient.java index 9b38a5ca..57459868 100644 --- a/racevisionGame/src/main/java/visualiser/gameController/ControllerClient.java +++ b/racevisionGame/src/main/java/visualiser/gameController/ControllerClient.java @@ -39,7 +39,7 @@ public class ControllerClient { /** * Send a keypress to server * @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 { BoatActionEnum protocolCode = key.getProtocolCode(); diff --git a/racevisionGame/src/test/java/mock/model/MockRaceTest.java b/racevisionGame/src/test/java/mock/model/MockRaceTest.java index 3c01b321..402e37f0 100644 --- a/racevisionGame/src/test/java/mock/model/MockRaceTest.java +++ b/racevisionGame/src/test/java/mock/model/MockRaceTest.java @@ -19,9 +19,9 @@ public class MockRaceTest { * Creates a MockRace for use in testing. * Has a constant wind generator. * @return MockRace for testing. - * @throws InvalidBoatDataException - * @throws InvalidRaceDataException - * @throws InvalidRegattaDataException + * @throws InvalidBoatDataException If the BoatDataSource cannot be created. + * @throws InvalidRaceDataException If the RaceDataSource cannot be created. + * @throws InvalidRegattaDataException If the RegattaDataSource cannot be created. */ public static MockRace createMockRace() throws InvalidBoatDataException, InvalidRaceDataException, InvalidRegattaDataException {