From 3f910b8db7edcd3e709630e0329702286b2169b2 Mon Sep 17 00:00:00 2001 From: Michael Rausch Date: Fri, 1 Sep 2017 16:13:18 +1200 Subject: [PATCH] Fixed JavaDoc errors by adding missing parameters --- src/main/java/seng302/gameServer/ServerAdvertiser.java | 4 ++-- .../seng302/gameServer/messages/MarkRoundingMessage.java | 1 + src/main/java/seng302/model/ServerYacht.java | 8 +++++--- .../java/seng302/visualiser/fxObjects/BoatObject.java | 6 ++++-- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/main/java/seng302/gameServer/ServerAdvertiser.java b/src/main/java/seng302/gameServer/ServerAdvertiser.java index 6b5f07da..6007f248 100644 --- a/src/main/java/seng302/gameServer/ServerAdvertiser.java +++ b/src/main/java/seng302/gameServer/ServerAdvertiser.java @@ -54,7 +54,7 @@ public class ServerAdvertiser { } /** - * Set the map name & broadcast an update on the network + * Set the map name and broadcast an update on the network * @param mapName The new map name * @return The current ServerAdvertiser instance */ @@ -69,7 +69,7 @@ public class ServerAdvertiser { } /** - * Set the spaces left on the server & broadcast an update on the network + * Set the spaces left on the server and broadcast an update on the network * @param spacesLeft The number of spaces left on the server * @return The current ServerAdvertiser instance */ diff --git a/src/main/java/seng302/gameServer/messages/MarkRoundingMessage.java b/src/main/java/seng302/gameServer/messages/MarkRoundingMessage.java index c32a6927..b1276814 100644 --- a/src/main/java/seng302/gameServer/messages/MarkRoundingMessage.java +++ b/src/main/java/seng302/gameServer/messages/MarkRoundingMessage.java @@ -22,6 +22,7 @@ public class MarkRoundingMessage extends Message{ * @param roundingBoatStatus roundingBoatStatus * @param roundingSide roundingSide * @param markId markId + * @param markType . */ public MarkRoundingMessage(int ackNumber, int raceId, int sourceId, RoundingBoatStatus roundingBoatStatus, RoundingSide roundingSide, MarkType markType, int markId) { diff --git a/src/main/java/seng302/model/ServerYacht.java b/src/main/java/seng302/model/ServerYacht.java index 64143023..859db93c 100644 --- a/src/main/java/seng302/model/ServerYacht.java +++ b/src/main/java/seng302/model/ServerYacht.java @@ -1,8 +1,5 @@ package seng302.model; -import java.util.HashMap; -import java.util.Observable; -import java.util.Observer; import javafx.scene.paint.Color; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -11,6 +8,10 @@ import seng302.gameServer.messages.BoatStatus; import seng302.model.mark.Mark; import seng302.utilities.GeoUtility; +import java.util.HashMap; +import java.util.Observable; +import java.util.Observer; + /** * Yacht class for the racing boat.

Class created to store more variables (eg. boat statuses) * compared to the XMLParser boat class, also done outside Boat class because some old variables are @@ -123,6 +124,7 @@ public class ServerYacht extends Observable { /** * Swaps the boats direction from one side of the wind to the other. + * @param windDirection . */ public void tackGybe(Double windDirection) { if (isAuto) { diff --git a/src/main/java/seng302/visualiser/fxObjects/BoatObject.java b/src/main/java/seng302/visualiser/fxObjects/BoatObject.java index a86a3ac8..ccabe35d 100644 --- a/src/main/java/seng302/visualiser/fxObjects/BoatObject.java +++ b/src/main/java/seng302/visualiser/fxObjects/BoatObject.java @@ -1,7 +1,5 @@ package seng302.visualiser.fxObjects; -import java.util.ArrayList; -import java.util.List; import javafx.application.Platform; import javafx.geometry.Point2D; import javafx.scene.Group; @@ -14,6 +12,9 @@ import javafx.scene.shape.Polyline; import javafx.scene.shape.StrokeLineCap; import javafx.scene.transform.Rotate; +import java.util.ArrayList; +import java.util.List; + /** * BoatGroup is a javafx group that by default contains a graphical objects for representing a 2 * dimensional boat. It contains a single polygon for the boat, a group of lines to show it's path, @@ -130,6 +131,7 @@ public class BoatObject extends Group { * @param rotation The rotation by which the boat moves * @param velocity The velocity the boat is moving * @param sailIn Boolean to toggle sail state. + * @param windDir . */ public void moveTo(double x, double y, double rotation, double velocity, Boolean sailIn, double windDir) { Double dx = Math.abs(boatPoly.getLayoutX() - x);