Added Javadoc comments

src/StartGUI.java

@@ -69,54 +69,112 @@ public class StartGUI {
         this.player = playerTemp;
     }
 
+    /**
+     * Initializes the Start GUI the game.
+     *
+     * @param stage object of type Stage
+     * @return returns the stage of GUI
+     */
     public Stage initializeStart(Stage stage){
 
+        /**
+         * Creates an HBox at the center of the borderpane with a width of 200, height of 100 and spacing of 10.
+         *
+         */
         borderPane.setAlignment(hBox, javafx.geometry.Pos.CENTER);
         hBox.setAlignment(javafx.geometry.Pos.CENTER);
         hBox.setPrefHeight(100.0);
         hBox.setPrefWidth(200.0);
         hBox.setSpacing(10.0);
 
+        /**
+         * Creates a borderpane window of width 600 and height 480.
+         *
+         */
         borderPane.setPrefHeight(480.0);
         borderPane.setPrefWidth(600.0);
 
-        nameField.setPromptText("Enter your name.");
+        /**
+         * Creates a prompt text field that asks for your firm name and has a default text set to "Taipan".
+         *
+         */
+        nameField.setPromptText("Enter Firm Name.");
         nameField.setText("Taipan");
 
+        /**
+         * Creates a button with text "Start"
+         *
+         */
         startButton.setMnemonicParsing(false);
         startButton.setText("Start");
 
+        /**
+         * Creates a VBox at the left of center of the borderpane.
+         *
+         */
         vBox.setAlignment(javafx.geometry.Pos.CENTER_LEFT);
 
+        /**
+         * Creates a label with text "Do you want to start with..." to indicate the user has to choose between 2 given scenarios.
+         *
+         */
         choiceLabel.setText("Do you want to start with...");
 
+        /**
+         * Label for scenario one which is you start with five guns and no cash or debt.
+         *
+         */
         gunChoice.setMnemonicParsing(false);
         gunChoice.setSelected(true);
         gunChoice.setText("Five guns and no cash (But no debt!)?");
 
         gunChoice.setToggleGroup(Start);
 
+        /**
+         * Label for scenario 2 which is you start with cash but also a debt.
+         *
+         */
         cashChoice.setAlignment(javafx.geometry.Pos.TOP_LEFT);
         cashChoice.setMnemonicParsing(false);
         cashChoice.setText("Cash (and a debt)");
         cashChoice.setToggleGroup(Start);
         borderPane.setBottom(hBox);
 
+        /**
+         * Creates a VBox at the center of the borderpane with a width of 100 and height of 200.
+         *
+         */
         BorderPane.setAlignment(vBox0, javafx.geometry.Pos.CENTER);
         vBox0.setAlignment(javafx.geometry.Pos.CENTER);
         vBox0.setPrefHeight(200.0);
         vBox0.setPrefWidth(100.0);
 
+        /**
+         * Creates a label with text "Taipan" in size 66 font and default font style.
+         *
+         */
         title.setText("Taipan");
         title.setFont(new Font(66.0));
 
+        /**
+         * Creates a label with our names as text
+         *
+         */
         authors.setPrefHeight(80.0);
         authors.setPrefWidth(499.0);
         authors.setText("By Vikram Bawa, Haris Muhammad, Siddhant Dewani, Nathan Lum and Harkamal Randhawa");
 
+        /**
+         * Puts Vbox0 in the center of the borderpane.
+         *
+         */
         authors.setTextAlignment(javafx.scene.text.TextAlignment.CENTER);
         borderPane.setCenter(vBox0);
 
+        /**
+         * Adds all the buttons and labels to their respective boxes.
+         *
+         */
         hBox.getChildren().add(nameField);
         hBox.getChildren().add(startButton);
         vBox.getChildren().add(choiceLabel);
@@ -126,6 +184,11 @@ public class StartGUI {
         vBox0.getChildren().add(title);
         vBox0.getChildren().add(authors);
 
+        /**
+         * Adds function to the "Start" button, scenario 1 gives the player $400 and a $5000 debt at the start of the game;
+         * scenario 2 gives the player 5 guns.
+         *
+         */
         startButton.setOnAction(new EventHandler<ActionEvent>() {
             @Override
             public void handle(ActionEvent event) {
@@ -143,9 +206,9 @@ public class StartGUI {
                 if (response.equalsIgnoreCase("Vikram")) {
                     player.setMoney(999999999);
                     player.setBank(999999999);
-                    player.setGuns(999);
+                    player.setGuns(0);
-                    player.setHP(999999999);
+                    player.setHP(99999999);
-                    player.setCargoSpace(999999999);
+                    player.setCargoSpace(Integer.MAX_VALUE);
                 }
                 setFirm(response);