From 5ea4200e67b439c4618e9295a5dfba5e04493ded Mon Sep 17 00:00:00 2001 From: fjc40 Date: Wed, 27 Sep 2017 14:47:51 +1300 Subject: [PATCH] Some javadoc warning fixes. --- racevisionGame/src/main/java/mock/app/Event.java | 1 + racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java | 4 ++-- .../src/main/java/visualiser/layout/HealthEffect.java | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/racevisionGame/src/main/java/mock/app/Event.java b/racevisionGame/src/main/java/mock/app/Event.java index 1a70b65c..11553a07 100644 --- a/racevisionGame/src/main/java/mock/app/Event.java +++ b/racevisionGame/src/main/java/mock/app/Event.java @@ -66,6 +66,7 @@ public class Event { * Constructs an event, using various XML files. * @param singlePlayer Whether or not to create a single player event. * @param mapIndex Specifies which map to use. + * @param raceLength The length of the race, in milliseconds. * @throws EventConstructionException Thrown if we cannot create an Event for any reason. */ public Event(boolean singlePlayer, int mapIndex, int raceLength) throws diff --git a/racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java b/racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java index 502e6ab6..af7fbe45 100644 --- a/racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java +++ b/racevisionGame/src/main/java/mock/xml/RaceXMLCreator.java @@ -177,10 +177,10 @@ public class RaceXMLCreator { } /** - * gets the destance between two marks + * gets the destance between two marks, in nautical miles. * @param a mark 1 * @param b mark 2 - * @return + * @return Distance in nautical miles. */ private static double getDistance(XMLMark a, XMLMark b){ GPSCoordinate coorda = new GPSCoordinate(a.getTargetLat(), a.getTargetLng()); diff --git a/racevisionGame/src/main/java/visualiser/layout/HealthEffect.java b/racevisionGame/src/main/java/visualiser/layout/HealthEffect.java index d41effa1..b3b7d70b 100644 --- a/racevisionGame/src/main/java/visualiser/layout/HealthEffect.java +++ b/racevisionGame/src/main/java/visualiser/layout/HealthEffect.java @@ -91,6 +91,7 @@ public class HealthEffect extends Subject3D { * Flash the mesh view at a certain interval * @param checkTime The current time of flash * @param flashInterval Desired flash interval + * @param playerBoat Whether or not this effect is for the player's boat. */ public void flash(long checkTime, long flashInterval, boolean playerBoat){ if(checkTime >= (currentTime+flashInterval)){