javadoc

UmerFakher · Feb 9, 2021 · 45bf6fa · 45bf6fa
1 parent 8f27b28
commit 45bf6fa
Show file tree

Hide file tree

Showing 143 changed files with 1,781 additions and 1,248 deletions.
diff --git a/core/src/main/java/com/dragonboatrace/screens/RoundsScreen.java b/core/src/main/java/com/dragonboatrace/screens/RoundsScreen.java
@@ -193,6 +193,7 @@ public void saveGame(){
 
  /**
  * Created to allow testing without rendering
+ * @return the leaderboard string
  */
  public String getReason() {
  return reason;

diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>All Classes</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>All Classes</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/AssetTest.html b/docs/com/dragonboatrace/AssetTest.html
diff --git a/docs/com/dragonboatrace/DragonBoatRace.html b/docs/com/dragonboatrace/DragonBoatRace.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>DragonBoatRace</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/DragonBoatRaceTest.html b/docs/com/dragonboatrace/DragonBoatRaceTest.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>DragonBoatRaceTest</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../script.js"></script>
 </head>
@@ -18,7 +18,7 @@
  catch(err) {
  }
 //-->
-var methods = {"i0":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -111,6 +111,7 @@ <h2 title="Class DragonBoatRaceTest" class="title">Class DragonBoatRaceTest</h2>
 <br>
 <pre>public class <span class="typeNameLabel">DragonBoatRaceTest</span>
 extends java.lang.Object</pre>
+<div class="block">TUA_FRAMEWORK_TEST - Make sure the unit test framework is running and accurate.</div>
 </li>
 </ul>
 </div>
@@ -148,7 +149,27 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/DragonBoatRaceTest.html#testTesting--">testTesting</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/DragonBoatRaceTest.html#finishLineTest--">finishLineTest</a></span>()</code>
+<div class="block">TI_FINISH_LINE - Check that the game finishes a round when the boat passes the finish line.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/DragonBoatRaceTest.html#joinFinalTest--">joinFinalTest</a></span>()</code>
+<div class="block">TI_FINAL - Check the game correctly determines if you should be in the final or not.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/DragonBoatRaceTest.html#resultPositionTest--">resultPositionTest</a></span>()</code>
+<div class="block">TI_RESULT_POSITIONS - Check the game gives awards to the correct boats at the end of the final race.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/DragonBoatRaceTest.html#testingFrameworkInitialTest--">testingFrameworkInitialTest</a></span>()</code>
+<div class="block">TUA_FRAMEWORK_TEST - Make sure the unit test framework is running and accurate.</div>
+</td>
 </tr>
 </table>
 <ul class="blockList">
@@ -189,18 +210,55 @@ <h4>DragonBoatRaceTest</h4>
 <!-- -->
 </a>
 <h3>Method Detail</h3>
-<a name="testTesting--">
+<a name="testingFrameworkInitialTest--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>testingFrameworkInitialTest</h4>
+<pre>public&nbsp;void&nbsp;testingFrameworkInitialTest()</pre>
+<div class="block">TUA_FRAMEWORK_TEST - Make sure the unit test framework is running and accurate.
+ TI_FINISH_LINE - Check that the game finishes a round when the boat passes the finish line.
+ TI_FINAL - Check the game correctly determines if you should be in the final or not.
+ TI_RESULT_POSITIONS - Check the game gives awards to the correct boats at the end of the final race.
+
+ Created to test the gradle test system works.</div>
+</li>
+</ul>
+<a name="finishLineTest--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>finishLineTest</h4>
+<pre>public&nbsp;void&nbsp;finishLineTest()</pre>
+<div class="block">TI_FINISH_LINE - Check that the game finishes a round when the boat passes the finish line.
+
+ The game screen is changed when a boat comes into contact with the finish line.</div>
+</li>
+</ul>
+<a name="joinFinalTest--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>joinFinalTest</h4>
+<pre>public&nbsp;void&nbsp;joinFinalTest()</pre>
+<div class="block">TI_FINAL - Check the game correctly determines if you should be in the final or not.
+
+ If the player is within the top 4 the game screen is changed to the game screen.</div>
+</li>
+</ul>
+<a name="resultPositionTest--">
 <!-- -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
-<h4>testTesting</h4>
-<pre>public&nbsp;void&nbsp;testTesting()
- throws java.lang.Exception</pre>
-<dl>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.lang.Exception</code></dd>
-</dl>
+<h4>resultPositionTest</h4>
+<pre>public&nbsp;void&nbsp;resultPositionTest()</pre>
+<div class="block">TI_RESULT_POSITIONS - Check the game gives awards to the correct boats at the end of the final race.
+
+ If the player comes in first place in the final it reflects that in the reason string.</div>
 </li>
 </ul>
 </li>

diff --git a/docs/com/dragonboatrace/SaveLoadTest.html b/docs/com/dragonboatrace/SaveLoadTest.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>SaveLoadTest</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../script.js"></script>
 </head>
@@ -111,6 +111,8 @@ <h2 title="Class SaveLoadTest" class="title">Class SaveLoadTest</h2>
 <br>
 <pre>public class <span class="typeNameLabel">SaveLoadTest</span>
 extends java.lang.Object</pre>
+<div class="block">TI_LOAD_SAVE - Check the state of the game is the same as the savefile when the user loads a savefile.
+ TU_INVALID_SAVE - Check the game correctly identifies an invalid save.</div>
 </li>
 </ul>
 </div>
@@ -148,11 +150,15 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/SaveLoadTest.html#invalidFileTest--">invalidFileTest</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/SaveLoadTest.html#invalidFileTest--">invalidFileTest</a></span>()</code>
+<div class="block">TU_INVALID_SAVE - Check the game correctly identifies an invalid save.</div>
+</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/SaveLoadTest.html#saveLoadTest--">saveLoadTest</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../com/dragonboatrace/SaveLoadTest.html#saveLoadTest--">saveLoadTest</a></span>()</code>
+<div class="block">TI_LOAD_SAVE - Check the state of the game is the same as the savefile when the user loads a savefile.</div>
+</td>
 </tr>
 </table>
 <ul class="blockList">
@@ -200,6 +206,9 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>saveLoadTest</h4>
 <pre>public&nbsp;void&nbsp;saveLoadTest()</pre>
+<div class="block">TI_LOAD_SAVE - Check the state of the game is the same as the savefile when the user loads a savefile.
+
+ The difficulty, round stored times and boat type should be the same as when the save file was made when a save file is loaded.</div>
 </li>
 </ul>
 <a name="invalidFileTest--">
@@ -209,6 +218,9 @@ <h4>saveLoadTest</h4>
 <li class="blockList">
 <h4>invalidFileTest</h4>
 <pre>public&nbsp;void&nbsp;invalidFileTest()</pre>
+<div class="block">TU_INVALID_SAVE - Check the game correctly identifies an invalid save.
+
+ The game should do nothing if the load button is pressed for an invalid save.</div>
 </li>
 </ul>
 </li>

diff --git a/docs/com/dragonboatrace/class-use/AssetTest.html b/docs/com/dragonboatrace/class-use/AssetTest.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Class com.dragonboatrace.AssetTest</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/class-use/DragonBoatRace.html b/docs/com/dragonboatrace/class-use/DragonBoatRace.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Class com.dragonboatrace.DragonBoatRace</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/class-use/DragonBoatRaceTest.html b/docs/com/dragonboatrace/class-use/DragonBoatRaceTest.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Class com.dragonboatrace.DragonBoatRaceTest</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/class-use/SaveLoadTest.html b/docs/com/dragonboatrace/class-use/SaveLoadTest.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Class com.dragonboatrace.SaveLoadTest</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/DesktopLauncher.html b/docs/com/dragonboatrace/desktop/DesktopLauncher.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:27 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>DesktopLauncher</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/class-use/DesktopLauncher.html b/docs/com/dragonboatrace/desktop/class-use/DesktopLauncher.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Class com.dragonboatrace.desktop.DesktopLauncher</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/package-frame.html b/docs/com/dragonboatrace/desktop/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>com.dragonboatrace.desktop</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/package-summary.html b/docs/com/dragonboatrace/desktop/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>com.dragonboatrace.desktop</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/package-tree.html b/docs/com/dragonboatrace/desktop/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>com.dragonboatrace.desktop Class Hierarchy</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/desktop/package-use.html b/docs/com/dragonboatrace/desktop/package-use.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:28 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Uses of Package com.dragonboatrace.desktop</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/dragonboatrace/entities/Button.html b/docs/com/dragonboatrace/entities/Button.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_282) on Mon Feb 08 15:04:27 GMT 2021 -->
+<!-- Generated by javadoc (1.8.0_282) on Tue Feb 09 16:04:37 GMT 2021 -->
 <title>Button</title>
-<meta name="date" content="2021-02-08">
+<meta name="date" content="2021-02-09">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>