- Added documentation to controllers

tags : #story[1245]
This commit is contained in:
Alistair McIntyre
2017-09-12 16:54:40 +12:00
parent 9dad88e56a
commit 7e9e96c091
13 changed files with 82 additions and 120 deletions
@@ -4,17 +4,15 @@ import com.jfoenix.controls.JFXButton;
import com.jfoenix.controls.JFXColorPicker;
import com.jfoenix.controls.JFXTextField;
import com.jfoenix.validation.RequiredFieldValidator;
import java.net.URL;
import java.util.ResourceBundle;
import javafx.event.ActionEvent;
import javafx.fxml.FXML;
import javafx.fxml.Initializable;
import javafx.scene.paint.Color;
import javafx.stage.Stage;
import seng302.gameServer.messages.CustomizeRequestType;
import seng302.utilities.Sounds;
import seng302.visualiser.ClientToServerThread;
import java.net.URL;
import java.util.ResourceBundle;
import seng302.visualiser.controllers.LobbyController;
import seng302.visualiser.validators.FieldLengthValidator;
import seng302.visualiser.validators.ValidationTools;
@@ -56,7 +54,7 @@ public class BoatCustomizeController implements Initializable{
}
/**
*
* Attempts to submit a valid customization packet for boat name and boat color.
*/
private void submitCustomization() {
@@ -4,6 +4,8 @@ import com.jfoenix.controls.JFXButton;
import com.jfoenix.controls.JFXSlider;
import com.jfoenix.controls.JFXTextField;
import com.jfoenix.validation.RequiredFieldValidator;
import java.net.URL;
import java.util.ResourceBundle;
import javafx.fxml.FXML;
import javafx.fxml.Initializable;
import javafx.scene.control.Label;
@@ -12,9 +14,6 @@ import seng302.gameServer.ServerDescription;
import seng302.utilities.Sounds;
import seng302.visualiser.controllers.ViewManager;
import seng302.visualiser.validators.FieldLengthValidator;
import java.net.URL;
import java.util.ResourceBundle;
import seng302.visualiser.validators.ValidationTools;
public class ServerCreationController implements Initializable {
@@ -51,7 +50,7 @@ public class ServerCreationController implements Initializable {
}
/**
*
* Validates that a server has a valid name and creates the server.
*/
private void validateServerSettings() {
submitBtn.setText("CREATING...");
@@ -63,7 +62,7 @@ public class ServerCreationController implements Initializable {
}
/**
*
* Creates a server with a given set of details.
*/
private void createServer() {
ServerDescription serverDescription = ViewManager.getInstance().getGameClient()
@@ -75,7 +74,7 @@ public class ServerCreationController implements Initializable {
}
/**
*
* Updates a label as the user slides along the max players slider.
*/
private void updateMaxPlayerLabel() {
maxPlayersSlider.setValue(Math.floor(maxPlayersSlider.getValue()));