From 442920f9f66acdde42b7cc998eb8dcd9d83932be Mon Sep 17 00:00:00 2001 From: Fan-Wu Yang Date: Thu, 27 Jul 2017 16:24:19 +1200 Subject: [PATCH] DOD, and added javadocs/fixed javadocs #story[1087] --- racevisionGame/src/main/java/mock/app/App.java | 0 .../src/main/java/mock/app/MockOutput.java | 3 ++- .../visualiser/Controllers/HostController.java | 14 +++++++++++++- .../visualiser/Controllers/LobbyController.java | 11 ++++++++++- .../visualiser/Controllers/MainController.java | 1 + .../visualiser/Controllers/RaceController.java | 1 + .../visualiser/Controllers/TitleController.java | 9 +++++++++ .../main/java/visualiser/model/RaceConnection.java | 3 ++- 8 files changed, 38 insertions(+), 4 deletions(-) delete mode 100644 racevisionGame/src/main/java/mock/app/App.java diff --git a/racevisionGame/src/main/java/mock/app/App.java b/racevisionGame/src/main/java/mock/app/App.java deleted file mode 100644 index e69de29b..00000000 diff --git a/racevisionGame/src/main/java/mock/app/MockOutput.java b/racevisionGame/src/main/java/mock/app/MockOutput.java index 12eaf807..aff0947e 100644 --- a/racevisionGame/src/main/java/mock/app/MockOutput.java +++ b/racevisionGame/src/main/java/mock/app/MockOutput.java @@ -58,7 +58,8 @@ public class MockOutput implements Runnable /** * Ctor. - * + * @param latestMessages Latests Messages that the Mock is to send out + * @param outToVisualiser DataStream to output to Visualisers * @throws IOException if server socket cannot be opened. */ public MockOutput(LatestMessages latestMessages, DataOutputStream outToVisualiser) throws IOException { diff --git a/racevisionGame/src/main/java/visualiser/Controllers/HostController.java b/racevisionGame/src/main/java/visualiser/Controllers/HostController.java index e6e0f706..e87ea689 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/HostController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/HostController.java @@ -19,7 +19,7 @@ import java.net.UnknownHostException; import java.util.ResourceBundle; /** - * Created by zwu18 on 25/07/17. + * Controller for Hosting a game. */ public class HostController extends Controller { @@ -38,6 +38,10 @@ public class HostController extends Controller { public void initialize(URL location, ResourceBundle resources) { } + /** + * Hosts a game + * @throws IOException if socket cannot be connected to + */ public void hostGamePressed() throws IOException{ try { Event game = Event.getEvent(); @@ -54,6 +58,11 @@ public class HostController extends Controller { } } + /** + * Connect to a socket + * @param address address of the server + * @param port port that the server is run off + */ public void connectSocket(String address, int port) { try{ Socket socket = new Socket(address, port); @@ -66,6 +75,9 @@ public class HostController extends Controller { return hostWrapper; } + /** + * Hosts a game. + */ public void hostGame(){ hostWrapper.setVisible(true); System.out.println("Reacted hostGame"); diff --git a/racevisionGame/src/main/java/visualiser/Controllers/LobbyController.java b/racevisionGame/src/main/java/visualiser/Controllers/LobbyController.java index f88b739f..dc4d8e59 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/LobbyController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/LobbyController.java @@ -17,7 +17,7 @@ import java.net.URL; import java.util.ResourceBundle; /** - * Created by zwu18 on 25/07/17. + * Controller for the Lobby for entering games */ public class LobbyController extends Controller { @@ -64,6 +64,9 @@ public class LobbyController extends Controller { joinGameBtn.setDisable(true); } + /** + * Refreshes the connections in the lobby + */ public void refreshBtnPressed(){ for(RaceConnection connection: connections) { connection.check(); @@ -82,6 +85,9 @@ public class LobbyController extends Controller { } catch (Exception e){} } + /** + * Connect to a connection. + */ public void connectSocket() { try{ RaceConnection connection = lobbyTable.getSelectionModel().getSelectedItem(); @@ -113,6 +119,9 @@ public class LobbyController extends Controller { return lobbyWrapper; } + /** + * Enter the lobby page. + */ public void enterLobby(){ lobbyWrapper.setVisible(true); } diff --git a/racevisionGame/src/main/java/visualiser/Controllers/MainController.java b/racevisionGame/src/main/java/visualiser/Controllers/MainController.java index 036e3aa2..80ef2da4 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/MainController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/MainController.java @@ -38,6 +38,7 @@ public class MainController extends Controller { * Transitions from the StartController screen (displays pre-race information) to the RaceController (displays the actual race). * @param visualiserInput The object used to read packets from the race server. * @param visualiserRace The object modelling the race. + * @param controllerClient Socket Client that manipulates the controller. */ public void beginRace(VisualiserInput visualiserInput, VisualiserRace visualiserRace, ControllerClient controllerClient) { raceController.startRace(visualiserInput, visualiserRace, controllerClient); diff --git a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java index a15e826c..5777c06e 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java @@ -338,6 +338,7 @@ public class RaceController extends Controller { * Displays a specified race. * @param visualiserInput Object used to read packets from server. * @param visualiserRace Object modelling the race. + * @param controllerClient Socket Client that manipulates the controller. */ public void startRace(VisualiserInput visualiserInput, VisualiserRace visualiserRace, ControllerClient controllerClient) { diff --git a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java index 6b665b6e..412858ee 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java @@ -43,6 +43,9 @@ public class TitleController extends Controller { App.getStage().setResizable(true); } + /** + * Switch the scene to the title page. + */ public void enterTitle(){ titleWrapper.setVisible(true); } @@ -57,12 +60,18 @@ public class TitleController extends Controller { App.getStage().setResizable(true); } + /** + * Switches the css of the program to day mode theme + */ public void setDayMode(){ dayModeRD.getScene().getStylesheets().clear(); dayModeRD.getScene().getStylesheets().add("/css/dayMode.css"); nightModeRD.setSelected(false); } + /** + * Switches the css of the program to night mode theme + */ public void setNightMode(){ nightModeRD.getScene().getStylesheets().clear(); nightModeRD.getScene().getStylesheets().add("/css/nightMode.css"); diff --git a/racevisionGame/src/main/java/visualiser/model/RaceConnection.java b/racevisionGame/src/main/java/visualiser/model/RaceConnection.java index 62da510f..f9f2d4ea 100644 --- a/racevisionGame/src/main/java/visualiser/model/RaceConnection.java +++ b/racevisionGame/src/main/java/visualiser/model/RaceConnection.java @@ -8,7 +8,7 @@ import java.net.InetSocketAddress; import java.net.Socket; /** - * Created by cbt24 on 3/05/17. + * Connection for Races */ public class RaceConnection { private final StringProperty hostname; @@ -21,6 +21,7 @@ public class RaceConnection { * Constructor for remote host connections. * @param hostname URL for remote host * @param port port for game feed + * @param gamename Name of the game */ public RaceConnection(String hostname, int port, String gamename) { this.hostname = new SimpleStringProperty(hostname);