From 598275591feca7a6c921f2e59ad746734a3cc80c Mon Sep 17 00:00:00 2001 From: David Wu Date: Thu, 17 Aug 2017 16:50:51 +1200 Subject: [PATCH] Updated javadoc. --- .../main/java/visualiser/Controllers/MainController.java | 1 + .../main/java/visualiser/Controllers/RaceController.java | 1 + .../main/java/visualiser/Controllers/StartController.java | 2 +- racevisionGame/src/main/java/visualiser/app/App.java | 7 ++++--- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/racevisionGame/src/main/java/visualiser/Controllers/MainController.java b/racevisionGame/src/main/java/visualiser/Controllers/MainController.java index 78c59052..57d18830 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/MainController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/MainController.java @@ -50,6 +50,7 @@ public class MainController extends Controller { /** * Transitions from the server selection screen to the pre-race lobby for a given server. * @param socket The server to read data from. + * @param isHost is connection a host */ public void enterLobby(Socket socket, Boolean isHost) { startController.enterLobby(socket, isHost); diff --git a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java index cbaa5a47..27bc4282 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java @@ -400,6 +400,7 @@ public class RaceController extends Controller { * Displays a specified race. * @param visualiserRace Object modelling the race. * @param controllerClient Socket Client that manipulates the controller. + * @param isHost is user a host */ public void startRace(VisualiserRaceEvent visualiserRace, ControllerClient controllerClient, Boolean isHost) { diff --git a/racevisionGame/src/main/java/visualiser/Controllers/StartController.java b/racevisionGame/src/main/java/visualiser/Controllers/StartController.java index 0fadf6c0..890eb816 100644 --- a/racevisionGame/src/main/java/visualiser/Controllers/StartController.java +++ b/racevisionGame/src/main/java/visualiser/Controllers/StartController.java @@ -250,7 +250,7 @@ public class StartController extends Controller { /** * Show starting information for a race given a socket. * @param socket network source of information - * @param isHost + * @param isHost is user a host */ public void enterLobby(Socket socket, Boolean isHost) { try { diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java index f0830a64..eeae5a5d 100644 --- a/racevisionGame/src/main/java/visualiser/app/App.java +++ b/racevisionGame/src/main/java/visualiser/app/App.java @@ -144,7 +144,8 @@ public class App extends Application { /** * Show the main stage after the splash screen - * @throws Exception + * @param stage main stage for application + * @throws Exception Throws an exception on error */ public void showMainStage(Stage stage) throws Exception { App.stage = stage; @@ -174,8 +175,8 @@ public class App extends Application { /** * Show the splash screen * @param initStage Initial stage - * @param task - * @param initCompletionHandler + * @param task Task for splash screen + * @param initCompletionHandler initCompletionHandler interface */ private void showSplash( final Stage initStage,