javadocs update.

.idea/workspace.xml

@@ -1,7 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="3114a2b9-4919-4fdf-8fd9-d03b60109ce4" name="Default Changelist" comment="" />
+    <list default="true" id="3114a2b9-4919-4fdf-8fd9-d03b60109ce4" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/TaipanShopGUI.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/TaipanShopGUI.java" afterDir="false" />
+    </list>
     <ignored path="$PROJECT_DIR$/out/" />
     <ignored path="C:\Users\Harkamal Randhawa\IdeaProjects\TaipanClone\.idea\shelf/" />
     <ignored path="$PROJECT_DIR$/.idea/shelf/" />
@@ -22,7 +25,7 @@
           </provider>
         </entry>
       </file>
-      <file pinned="false" current-in-tab="true">
+      <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/src/StartGUI.java">
           <provider selected="true" editor-type-id="text-editor">
             <state relative-caret-position="308">
@@ -47,21 +50,21 @@
         <entry file="file://$PROJECT_DIR$/src/TravelGUI.java">
           <provider selected="true" editor-type-id="text-editor">
             <state relative-caret-position="9114">
-              <caret line="453" column="33" selection-start-line="453" selection-start-column="33" selection-end-line="453" selection-end-column="33" />
+              <caret line="459" column="33" selection-start-line="459" selection-start-column="33" selection-end-line="459" selection-end-column="33" />
             </state>
           </provider>
         </entry>
       </file>
-      <file pinned="false" current-in-tab="false">
+      <file pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/src/TaipanShopGUI.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="204">
+            <state relative-caret-position="-48">
-              <caret line="95" column="42" lean-forward="true" selection-start-line="95" selection-start-column="42" selection-end-line="95" selection-end-column="42" />
+              <caret line="626" column="115" selection-start-line="626" selection-start-column="115" selection-end-line="626" selection-end-column="115" />
               <folding>
                 <element signature="n#!!doc" expanded="true" />
                 <element signature="imports" expanded="true" />
-                <element signature="e#23606#23607#0" expanded="true" />
+                <element signature="e#23685#23686#0" expanded="true" />
-                <element signature="e#23651#23652#0" expanded="true" />
+                <element signature="e#23730#23731#0" expanded="true" />
               </folding>
             </state>
           </provider>
@@ -79,8 +82,8 @@
       <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/src/ShipWarfareGUI.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="5901">
+            <state relative-caret-position="281">
-              <caret line="300" column="9" selection-start-line="300" selection-start-column="9" selection-end-line="300" selection-end-column="9" />
+              <caret line="435" column="11" selection-start-line="435" selection-start-column="8" selection-end-line="435" selection-end-column="11" />
               <folding>
                 <element signature="imports" expanded="true" />
               </folding>
@@ -133,11 +136,11 @@
       <find>continue</find>
       <find>cashTex</find>
       <find>cashTe</find>
-      <find>run</find>
       <find>loan</find>
       <find>get loa</find>
       <find>warehouse</find>
       <find>warehouse\n</find>
+      <find>run</find>
     </findStrings>
     <replaceStrings>
       <replace>HP</replace>
@@ -149,7 +152,7 @@
     </replaceStrings>
   </component>
   <component name="Git.Settings">
-    <option name="UPDATE_TYPE" value="REBASE" />
+    <option name="UPDATE_TYPE" value="MERGE" />
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
   </component>
   <component name="IdeDocumentHistory">
@@ -164,13 +167,13 @@
         <option value="$PROJECT_DIR$/src/ShipWarfare.java" />
         <option value="$PROJECT_DIR$/src/TravelGUI.java" />
         <option value="$PROJECT_DIR$/src/Player.java" />
-        <option value="$PROJECT_DIR$/src/TaipanShopGUI.java" />
-        <option value="$PROJECT_DIR$/src/StartGUI.java" />
         <option value="$PROJECT_DIR$/src/ShipWarfareGUI.java" />
+        <option value="$PROJECT_DIR$/src/StartGUI.java" />
+        <option value="$PROJECT_DIR$/src/TaipanShopGUI.java" />
       </list>
     </option>
   </component>
-  <component name="ProjectFrameBounds">
+  <component name="ProjectFrameBounds" extendedState="6">
     <option name="x" value="6" />
     <option name="y" value="26" />
     <option name="width" value="1189" />
@@ -596,11 +599,25 @@
       <option name="project" value="LOCAL" />
       <updated>1552339973224</updated>
     </task>
-    <option name="localTasksCounter" value="40" />
+    <task id="LOCAL-00040" summary="fixed one small issue.">
+      <created>1552352826307</created>
+      <option name="number" value="00040" />
+      <option name="presentableId" value="LOCAL-00040" />
+      <option name="project" value="LOCAL" />
+      <updated>1552352826307</updated>
+    </task>
+    <task id="LOCAL-00041" summary="fixed one small issue.">
+      <created>1552353433447</created>
+      <option name="number" value="00041" />
+      <option name="presentableId" value="LOCAL-00041" />
+      <option name="project" value="LOCAL" />
+      <updated>1552353433447</updated>
+    </task>
+    <option name="localTasksCounter" value="42" />
     <servers />
   </component>
   <component name="TimeTrackingManager">
-    <option name="totallyTimeSpent" value="84236000" />
+    <option name="totallyTimeSpent" value="86013000" />
   </component>
   <component name="ToolWindowManager">
     <frame x="-8" y="-8" width="1936" height="1056" extended-state="6" />
@@ -703,7 +720,6 @@
     <ignored-roots>
       <path value="$PROJECT_DIR$" />
     </ignored-roots>
-    <MESSAGE value="Missed one statement that I needed to encapsulate" />
     <MESSAGE value="Messed up player by setting money to 1000" />
     <MESSAGE value="Please find error" />
     <MESSAGE value="Super broken but fight button is in progress for shipwarfare" />
@@ -728,7 +744,8 @@
     <MESSAGE value="Changed one line of text in shipwarfare GUI" />
     <MESSAGE value="Fixed output for start and TaipanShop GUI" />
     <MESSAGE value="Added JavaDocs for ShipWarfare" />
-    <option name="LAST_COMMIT_MESSAGE" value="Added JavaDocs for ShipWarfare" />
+    <MESSAGE value="fixed one small issue." />
+    <option name="LAST_COMMIT_MESSAGE" value="fixed one small issue." />
   </component>
   <component name="editorHistoryManager">
     <entry file="uml://JAVA/ShipWarfare">
@@ -782,7 +799,7 @@
     <entry file="file://$PROJECT_DIR$/src/TravelGUI.java">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="9114">
-          <caret line="453" column="33" selection-start-line="453" selection-start-column="33" selection-end-line="453" selection-end-column="33" />
+          <caret line="459" column="33" selection-start-line="459" selection-start-column="33" selection-end-line="459" selection-end-column="33" />
         </state>
       </provider>
     </entry>
@@ -807,29 +824,6 @@
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/src/TaipanShopGUI.java">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="204">
-          <caret line="95" column="42" lean-forward="true" selection-start-line="95" selection-start-column="42" selection-end-line="95" selection-end-column="42" />
-          <folding>
-            <element signature="n#!!doc" expanded="true" />
-            <element signature="imports" expanded="true" />
-            <element signature="e#23606#23607#0" expanded="true" />
-            <element signature="e#23651#23652#0" expanded="true" />
-          </folding>
-        </state>
-      </provider>
-    </entry>
-    <entry file="file://$PROJECT_DIR$/src/ShipWarfareGUI.java">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="5901">
-          <caret line="300" column="9" selection-start-line="300" selection-start-column="9" selection-end-line="300" selection-end-column="9" />
-          <folding>
-            <element signature="imports" expanded="true" />
-          </folding>
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/src/MainGUI.java">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="651">
@@ -847,6 +841,29 @@
         </state>
       </provider>
     </entry>
+    <entry file="file://$PROJECT_DIR$/src/ShipWarfareGUI.java">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="281">
+          <caret line="435" column="11" selection-start-line="435" selection-start-column="8" selection-end-line="435" selection-end-column="11" />
+          <folding>
+            <element signature="imports" expanded="true" />
+          </folding>
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/src/TaipanShopGUI.java">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="-48">
+          <caret line="626" column="115" selection-start-line="626" selection-start-column="115" selection-end-line="626" selection-end-column="115" />
+          <folding>
+            <element signature="n#!!doc" expanded="true" />
+            <element signature="imports" expanded="true" />
+            <element signature="e#23685#23686#0" expanded="true" />
+            <element signature="e#23730#23731#0" expanded="true" />
+          </folding>
+        </state>
+      </provider>
+    </entry>
   </component>
   <component name="masterDetails">
     <states>

src/TaipanShopGUI.java

@@ -401,8 +401,13 @@ public class TaipanShopGUI {
         buyButton.setPrefHeight(25.0);
         buyButton.setPrefWidth(45.0);
         buyButton.setText("Buy");
-        // if the buy button is clicked, the main utility buttons are set to be invisible and the buying process begins.
         buyButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * if the buy button is clicked, the main utility buttons are set to be invisible and the buying process begins.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("shop");
@@ -416,6 +421,12 @@ public class TaipanShopGUI {
         sellButton.setText("Sell");
         // if the sell button is clicked, the main utility buttons are set to be invisible and the selling process begins.
         sellButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * if the sell button is clicked, the main utility buttons are set to be invisible and the selling process begins.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("shop");
@@ -428,8 +439,13 @@ public class TaipanShopGUI {
         sellButton.setMnemonicParsing(false);
 
         bankButton.setPrefHeight(25.0);
-        // opens the bank if the bank button is clicked.
         bankButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * opens the bank if the bank button is clicked.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 BankGUI bank = new BankGUI(getPlayer());
@@ -445,8 +461,13 @@ public class TaipanShopGUI {
         cargoButton.setText("Transfer");
         cargoButton.setMnemonicParsing(false);
         cargoButton.setPrefWidth(94.0);
-        // warehouse is entered when the warehouse button is clicked.
         cargoButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * warehouse is entered when the warehouse button is clicked.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 WarehouseGUI warehouseGUI = new WarehouseGUI(player);
@@ -459,8 +480,13 @@ public class TaipanShopGUI {
         loanButton.setMnemonicParsing(false);
         loanButton.setPrefHeight(25.0);
         loanButton.setPrefWidth(73.0);
-        // loan office is entered when the loan button is clicked.
         loanButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * loan office is entered when the loan button is clicked.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 LoanSharkGUI loan = new LoanSharkGUI(getPlayer());
@@ -474,8 +500,13 @@ public class TaipanShopGUI {
         quitButton.setMnemonicParsing(false);
         quitButton.setPrefWidth(90.0);
         quitButton.setText("Quit");
-        // the user is free to travel once the quit button is clicked.
         quitButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the user is free to travel once the quit button is clicked.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 player.setIsPriceChanged(1);
@@ -490,8 +521,13 @@ public class TaipanShopGUI {
         retireButton.setPrefWidth(49.0);
         retireButton.setText("Retire");
         retireButton.setVisible(false);
-        // the user wins the game when the retire button is clicked.
         retireButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the user wins the game when the retire button is clicked.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 retire(stage);
@@ -504,8 +540,13 @@ public class TaipanShopGUI {
         opiumButton.setPrefHeight(25.0);
         opiumButton.setText("Opium");
         opiumButton.setVisible(false);
-        // the opium buying/selling process starts as soon as the user clicks the opium button.
         opiumButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the opium buying/selling process starts as soon as the user clicks the opium button.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("input");
@@ -526,8 +567,13 @@ public class TaipanShopGUI {
         silkButton.setMnemonicParsing(false);
         silkButton.setText("Silk");
         silkButton.setVisible(false);
-        // the silk buying/selling process starts as soon as the user clicks the silk button.
         silkButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the silk buying/selling process starts as soon as the user clicks the silk button.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("input");
@@ -546,8 +592,13 @@ public class TaipanShopGUI {
         armsButton.setPrefWidth(86.0);
         armsButton.setMnemonicParsing(false);
         armsButton.setVisible(false);
-        // the arms buying/selling process starts as soon as the user clicks the arms button.
         armsButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the arms buying/selling process starts as soon as the user clicks the arms button.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("input");
@@ -570,8 +621,13 @@ public class TaipanShopGUI {
         generalButton.setPrefWidth(86.0);
         generalButton.setText("General");
         generalButton.setVisible(false);
-        // the general cargo buying/selling process starts as soon as the user clicks the general cargo button.
         generalButton.setOnAction(new EventHandler<ActionEvent>() {
+
+            /**
+             * the general cargo buying/selling process starts as soon as the user clicks the general cargo button.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(ActionEvent event) {
                 buttonSetup("input");
@@ -590,9 +646,14 @@ public class TaipanShopGUI {
         numberInput.setAlignment(javafx.geometry.Pos.CENTER_RIGHT);
         numberInput.setText("Enter amount here...");
         numberInput.setVisible(false);
-        // after the user inputs a valid input into the text field and presses Z or ENTER, the buying/selling ends and
-        // the user is returned to the regular shop dialogue.
         numberInput.setOnKeyPressed(new EventHandler<KeyEvent>() {
+
+            /**
+             * after the user inputs a valid input into the text field and presses Z or ENTER, the buying/selling ends
+             * and the user is returned to the regular shop dialogue.
+             *
+             * @param event -- the event corresponding to the button click
+             */
             @Override
             public void handle(KeyEvent event) {
                 boolean exit = true;