Fixed build. (Actually this time)

All doc string annotations were required to be fixed for all methods

tags: #issue[34]
This commit is contained in:
William Muir
2017-08-03 11:45:14 +12:00
parent 8e24c204fd
commit c655cb3fab
10 changed files with 24 additions and 4 deletions
@@ -64,7 +64,7 @@ public class ClientToServerThread implements Runnable {
*
* @param ipAddress a string of ip address to be connected to
* @param portNumber an integer port number
* @throws Exception SocketConnection if fail to connect to ip address and port number
* @throws IOException SocketConnection if fail to connect to ip address and port number
* combination
*/
public ClientToServerThread(String ipAddress, Integer portNumber) throws IOException {
@@ -182,6 +182,7 @@ public class ClientToServerThread implements Runnable {
/**
* Send the post-start race course information
* @param boatActionMessage The message to send
*/
public void sendBoatActionMessage(BoatActionMessage boatActionMessage) {
try {
@@ -277,6 +277,7 @@ public class GameClient {
/**
* Handle the key-pressed event from the text field.
* @param e The key event triggering this call
*/
public void keyPressed(KeyEvent e) {
BoatActionMessage boatActionMessage;
@@ -183,6 +183,7 @@ public class GameView extends Pane {
* case the course is added relative ot the border.
*
* @param newCourse the mark objects that make up the course.
* @param sequence The sequence the marks travel through
*/
public void updateCourse(List<CompoundMark> newCourse, List<Corner> sequence) {
markerObjects = new HashMap<>();
@@ -307,6 +308,7 @@ public class GameView extends Pane {
/**
* Draws all the boats.
* @param yachts The yachts to set in the race
*/
public void setBoats(List<Yacht> yachts) {
BoatObject newBoat;
@@ -108,6 +108,8 @@ public class BoatObject extends Group {
*
* @param x The X coordinate to move the boat to
* @param y The Y coordinate to move the boat to
* @param rotation The rotation by which the boat moves
* @param velocity The velocity the boat is moving
*/
public void moveTo(double x, double y, double rotation, double velocity) {
Double dx = Math.abs(boatPoly.getLayoutX() - x);