Fixed JavaDoc errors by adding missing parameters

This commit is contained in:
Michael Rausch
2017-09-01 16:13:18 +12:00
parent b346d5a706
commit 3f910b8db7
4 changed files with 12 additions and 7 deletions
@@ -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 * @param mapName The new map name
* @return The current ServerAdvertiser instance * @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 * @param spacesLeft The number of spaces left on the server
* @return The current ServerAdvertiser instance * @return The current ServerAdvertiser instance
*/ */
@@ -22,6 +22,7 @@ public class MarkRoundingMessage extends Message{
* @param roundingBoatStatus roundingBoatStatus * @param roundingBoatStatus roundingBoatStatus
* @param roundingSide roundingSide * @param roundingSide roundingSide
* @param markId markId * @param markId markId
* @param markType .
*/ */
public MarkRoundingMessage(int ackNumber, int raceId, int sourceId, RoundingBoatStatus roundingBoatStatus, public MarkRoundingMessage(int ackNumber, int raceId, int sourceId, RoundingBoatStatus roundingBoatStatus,
RoundingSide roundingSide, MarkType markType, int markId) { RoundingSide roundingSide, MarkType markType, int markId) {
+5 -3
View File
@@ -1,8 +1,5 @@
package seng302.model; package seng302.model;
import java.util.HashMap;
import java.util.Observable;
import java.util.Observer;
import javafx.scene.paint.Color; import javafx.scene.paint.Color;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -11,6 +8,10 @@ import seng302.gameServer.messages.BoatStatus;
import seng302.model.mark.Mark; import seng302.model.mark.Mark;
import seng302.utilities.GeoUtility; import seng302.utilities.GeoUtility;
import java.util.HashMap;
import java.util.Observable;
import java.util.Observer;
/** /**
* Yacht class for the racing boat. <p> Class created to store more variables (eg. boat statuses) * Yacht class for the racing boat. <p> 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 * 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. * Swaps the boats direction from one side of the wind to the other.
* @param windDirection .
*/ */
public void tackGybe(Double windDirection) { public void tackGybe(Double windDirection) {
if (isAuto) { if (isAuto) {
@@ -1,7 +1,5 @@
package seng302.visualiser.fxObjects; package seng302.visualiser.fxObjects;
import java.util.ArrayList;
import java.util.List;
import javafx.application.Platform; import javafx.application.Platform;
import javafx.geometry.Point2D; import javafx.geometry.Point2D;
import javafx.scene.Group; import javafx.scene.Group;
@@ -14,6 +12,9 @@ import javafx.scene.shape.Polyline;
import javafx.scene.shape.StrokeLineCap; import javafx.scene.shape.StrokeLineCap;
import javafx.scene.transform.Rotate; 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 * 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, * 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 rotation The rotation by which the boat moves
* @param velocity The velocity the boat is moving * @param velocity The velocity the boat is moving
* @param sailIn Boolean to toggle sail state. * @param sailIn Boolean to toggle sail state.
* @param windDir .
*/ */
public void moveTo(double x, double y, double rotation, double velocity, Boolean sailIn, double windDir) { public void moveTo(double x, double y, double rotation, double velocity, Boolean sailIn, double windDir) {
Double dx = Math.abs(boatPoly.getLayoutX() - x); Double dx = Math.abs(boatPoly.getLayoutX() - x);