librejack

Blackjack clone written in java
git clone https://github.com/michaelneuper/librejack.git
README | Files | Log | Refs | LICENSE

commit e519d65531b0d5f5def74bad3369b01e6149032a
parent 49b2fe73ca4fb648c3dba4d4da7bed8a3068004e
Author: Michael Neuper <michael@michaelneuper.com>
Date:   Fri, 28 Apr 2023 14:02:15 +0200

Update javadoc

Diffstat:
Mdocs/allclasses-frame.html | 4++--
Mdocs/allclasses-noframe.html | 4++--
Mdocs/constant-values.html | 6+++---
Mdocs/controller/Controller.html | 84++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------------
Mdocs/controller/Hand.html | 46++++++++++++++++++++++++++++++++++------------
Mdocs/controller/LoginController.html | 16++++++++++++----
Mdocs/controller/class-use/Controller.html | 6+++---
Mdocs/controller/class-use/Hand.html | 14+++++++++-----
Mdocs/controller/class-use/LoginController.html | 6+++---
Mdocs/controller/package-frame.html | 4++--
Mdocs/controller/package-summary.html | 13++++++++-----
Mdocs/controller/package-tree.html | 6+++---
Mdocs/controller/package-use.html | 6+++---
Mdocs/deprecated-list.html | 6+++---
Mdocs/help-doc.html | 6+++---
Mdocs/index-files/index-1.html | 8++++----
Mdocs/index-files/index-10.html | 23+++++++++++++++--------
Mdocs/index-files/index-11.html | 6+++---
Mdocs/index-files/index-12.html | 30++++++++++++++++++++----------
Mdocs/index-files/index-13.html | 27+++++++++++++++++++--------
Mdocs/index-files/index-14.html | 6+++---
Mdocs/index-files/index-2.html | 32++++++++++++++++++++------------
Mdocs/index-files/index-3.html | 17+++++++++--------
Mdocs/index-files/index-4.html | 8++++----
Mdocs/index-files/index-5.html | 38+++++++++++++++++++++++++++-----------
Mdocs/index-files/index-6.html | 12++++++------
Mdocs/index-files/index-7.html | 6+++---
Mdocs/index-files/index-8.html | 12+++++++-----
Mdocs/index-files/index-9.html | 6+++---
Mdocs/index.html | 4++--
Mdocs/model/Card.Rank.html | 16++++++++++++----
Mdocs/model/Card.Suit.html | 14++++++++++----
Mdocs/model/Card.html | 65+++++++++++++++++++++++++++++++++++++++++++++++++++--------------
Mdocs/model/Dealer.html | 44+++++++++++++++++++++++++++++++++++---------
Mdocs/model/Deck.html | 47++++++++++++++++++++++++++++++++---------------
Mdocs/model/Person.html | 79++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----------------
Mdocs/model/Player.html | 22++++++++++++++++++----
Mdocs/model/Statistics.html | 49++++++++++++++++++++++++++++++++-----------------
Mdocs/model/class-use/Card.Rank.html | 12+++++++-----
Mdocs/model/class-use/Card.Suit.html | 12+++++++-----
Mdocs/model/class-use/Card.html | 14++++++++------
Mdocs/model/class-use/Dealer.html | 6+++---
Mdocs/model/class-use/Deck.html | 11++++++-----
Mdocs/model/class-use/Person.html | 12++++++------
Mdocs/model/class-use/Player.html | 6+++---
Mdocs/model/class-use/Statistics.html | 9+++++----
Mdocs/model/package-frame.html | 4++--
Mdocs/model/package-summary.html | 31+++++++++++++++++++------------
Mdocs/model/package-tree.html | 6+++---
Mdocs/model/package-use.html | 30+++++++++++++++++++-----------
Mdocs/overview-frame.html | 4++--
Mdocs/overview-summary.html | 6+++---
Mdocs/overview-tree.html | 6+++---
Mdocs/serialized-form.html | 6+++---
Mdocs/view/LoginGUI.html | 9++++++---
Mdocs/view/MainGUI.html | 9++++++---
Mdocs/view/StatisticsGUI.html | 9++++++---
Mdocs/view/class-use/LoginGUI.html | 6+++---
Mdocs/view/class-use/MainGUI.html | 6+++---
Mdocs/view/class-use/StatisticsGUI.html | 6+++---
Mdocs/view/package-frame.html | 4++--
Mdocs/view/package-summary.html | 6+++---
Mdocs/view/package-tree.html | 6+++---
Mdocs/view/package-use.html | 6+++---
64 files changed, 695 insertions(+), 345 deletions(-)

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_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>All Classes</title> +<title>All Classes (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> 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_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>All Classes</title> +<title>All Classes (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> diff --git a/docs/constant-values.html b/docs/constant-values.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Constant Field Values</title> +<title>Constant Field Values (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Constant Field Values"; + parent.document.title="Constant Field Values (librejack)"; } } catch(err) { diff --git a/docs/controller/Controller.html b/docs/controller/Controller.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:37 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Controller</title> +<title>Controller (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Controller"; + parent.document.title="Controller (librejack)"; } } catch(err) { @@ -112,7 +112,19 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Controller</span> extends java.lang.Object</pre> -<div class="block">Handles most of the game logic.</div> +<div class="block"><p> + The Controller class is responsible for handling most of the game logic for a + Blackjack game.</p> + <p> + It creates a new instance of the Dealer and Player classes, initializes the + deck with a new shuffled and populated Deck object, and keeps track of the + bet and balance of the player. It also keeps track of game statistics using a + Statistics object.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> @@ -132,7 +144,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../controller/Controller.html#Controller--">Controller</a></span>()</code> -<div class="block">Controller Constructor: Initializes score to 0.</div> +<div class="block">Creates a new instance of the Controller class.</div> </td> </tr> </table> @@ -152,7 +164,9 @@ extends java.lang.Object</pre> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#checkWhoWins--">checkWhoWins</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#checkWhoWins--">checkWhoWins</a></span>()</code> +<div class="block">Checks who wins the game and returns a message indicating the result.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> @@ -180,11 +194,15 @@ extends java.lang.Object</pre> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#getBalance--">getBalance</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#getBalance--">getBalance</a></span>()</code> +<div class="block">Gets the current player's balance.</div> +</td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#getBet--">getBet</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#getBet--">getBet</a></span>()</code> +<div class="block">Gets the current player's bet.</div> +</td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> @@ -194,16 +212,21 @@ extends java.lang.Object</pre> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#setBalance-double-">setBalance</a></span>(double&nbsp;balance)</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#setBalance-double-">setBalance</a></span>(double&nbsp;balance)</code> +<div class="block">Sets the current player's balance.</div> +</td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#setBet-double-">setBet</a></span>(double&nbsp;bet)</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#setBet-double-">setBet</a></span>(double&nbsp;bet)</code> +<div class="block">Sets the current player's bet.</div> +</td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../controller/Controller.html#startRound--">startRound</a></span>()</code> -<div class="block">Handles logic for each round.</div> +<div class="block"> + Starts a new round of the game.</div> </td> </tr> </table> @@ -235,7 +258,9 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>Controller</h4> <pre>public&nbsp;Controller()</pre> -<div class="block">Controller Constructor: Initializes score to 0.</div> +<div class="block">Creates a new instance of the Controller class. Initializes the dealer + and player, the deck and discarded decks, and the bet and balance of the + player. The deck is also populated and shuffled.</div> </li> </ul> </li> @@ -253,6 +278,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getBet</h4> <pre>public&nbsp;double&nbsp;getBet()</pre> +<div class="block">Gets the current player's bet.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current player's bet</dd> +</dl> </li> </ul> <a name="setBet-double-"> @@ -262,6 +292,12 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>setBet</h4> <pre>public&nbsp;void&nbsp;setBet(double&nbsp;bet)</pre> +<div class="block">Sets the current player's bet. If it is greater than the total balance, + an error is displayed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bet</code> - the bet amount</dd> +</dl> </li> </ul> <a name="getBalance--"> @@ -271,6 +307,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getBalance</h4> <pre>public&nbsp;double&nbsp;getBalance()</pre> +<div class="block">Gets the current player's balance.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current player's balance</dd> +</dl> </li> </ul> <a name="setBalance-double-"> @@ -280,6 +321,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>setBalance</h4> <pre>public&nbsp;void&nbsp;setBalance(double&nbsp;balance)</pre> +<div class="block">Sets the current player's balance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>balance</code> - </dd> +</dl> </li> </ul> <a name="startRound--"> @@ -289,7 +335,13 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>startRound</h4> <pre>public&nbsp;void&nbsp;startRound()</pre> -<div class="block">Handles logic for each round.</div> +<div class="block"><p> + Starts a new round of the game.</p> + <p> + Discards the dealer and player hands to the discarded deck if there are + no cards left, and reloads the deck from the discarded deck if there are + fewer than four cards left. Deals two cards to the dealer and two cards + to the player.</p></div> </li> </ul> <a name="checkWhoWins--"> @@ -299,6 +351,12 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>checkWhoWins</h4> <pre>public&nbsp;java.lang.String&nbsp;checkWhoWins()</pre> +<div class="block">Checks who wins the game and returns a message indicating the result. + Increments game statistics for wins, losses, and pushes.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a message indicating the result of the game</dd> +</dl> </li> </ul> <a name="hitPlayer--"> diff --git a/docs/controller/Hand.html b/docs/controller/Hand.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:37 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Hand</title> +<title>Hand (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Hand"; + parent.document.title="Hand (librejack)"; } } catch(err) { @@ -114,6 +114,11 @@ var activeTableTab = "activeTableTab"; extends java.lang.Object</pre> <div class="block">Contains methods to calculate the value of a hand, take cards from a deck and discard the hand to a deck.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> @@ -133,7 +138,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../controller/Hand.html#Hand--">Hand</a></span>()</code> -<div class="block">Hand Constructor: Creates empty hand.</div> +<div class="block">Creates a new empty Hand object.</div> </td> </tr> </table> @@ -154,18 +159,21 @@ extends java.lang.Object</pre> <tr id="i0" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#calculateValue--">calculateValue</a></span>()</code> -<div class="block">Method to calculate the value of a hand.</div> +<div class="block">Calculates the value of a hand.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#discardHandToDeck-model.Deck-">discardHandToDeck</a></span>(<a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;discardDeck)</code> -<div class="block">Discards hand to deck.</div> +<div class="block">Discards the current hand and adds its cards to the specified discard + deck.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../model/Card.html" title="class in model">Card</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#getCard-int-">getCard</a></span>(int&nbsp;i)</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#getCard-int-">getCard</a></span>(int&nbsp;i)</code> +<div class="block">Gets the card at a specific index.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> @@ -175,7 +183,9 @@ extends java.lang.Object</pre> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#toString--">toString</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../controller/Hand.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string representation of the current hand.</div> +</td> </tr> </table> <ul class="blockList"> @@ -206,7 +216,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>Hand</h4> <pre>public&nbsp;Hand()</pre> -<div class="block">Hand Constructor: Creates empty hand.</div> +<div class="block">Creates a new empty Hand object.</div> </li> </ul> </li> @@ -238,7 +248,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>calculateValue</h4> <pre>public&nbsp;int&nbsp;calculateValue()</pre> -<div class="block">Method to calculate the value of a hand.</div> +<div class="block">Calculates the value of a hand.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>value value of the hand</dd> @@ -252,6 +262,13 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getCard</h4> <pre>public&nbsp;<a href="../model/Card.html" title="class in model">Card</a>&nbsp;getCard(int&nbsp;i)</pre> +<div class="block">Gets the card at a specific index.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>i</code> - the index of the card or get</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the card at index i</dd> +</dl> </li> </ul> <a name="discardHandToDeck-model.Deck-"> @@ -261,10 +278,12 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>discardHandToDeck</h4> <pre>public&nbsp;void&nbsp;discardHandToDeck(<a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;discardDeck)</pre> -<div class="block">Discards hand to deck.</div> +<div class="block">Discards the current hand and adds its cards to the specified discard + deck.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>discardDeck</code> - </dd> +<dd><code>discardDeck</code> - the deck to which the current hand's cards will be + added</dd> </dl> </li> </ul> @@ -275,9 +294,12 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> +<div class="block">Returns a string representation of the current hand.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a string representation of the current hand</dd> </dl> </li> </ul> diff --git a/docs/controller/LoginController.html b/docs/controller/LoginController.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:37 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>LoginController</title> +<title>LoginController (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="LoginController"; + parent.document.title="LoginController (librejack)"; } } catch(err) { @@ -112,7 +112,15 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">LoginController</span> extends java.lang.Object</pre> -<div class="block">Controller for handling user login.</div> +<div class="block"><p> + Controller for handling user login.</p> + <p> + Validates all login fields.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> diff --git a/docs/controller/class-use/Controller.html b/docs/controller/class-use/Controller.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class controller.Controller</title> +<title>Uses of Class controller.Controller (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class controller.Controller"; + parent.document.title="Uses of Class controller.Controller (librejack)"; } } catch(err) { diff --git a/docs/controller/class-use/Hand.html b/docs/controller/class-use/Hand.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class controller.Hand</title> +<title>Uses of Class controller.Hand (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class controller.Hand"; + parent.document.title="Uses of Class controller.Hand (librejack)"; } } catch(err) { @@ -105,7 +105,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code><a href="../../controller/Hand.html" title="class in controller">Hand</a></code></td> -<td class="colLast"><span class="typeNameLabel">Person.</span><code><span class="memberNameLink"><a href="../../model/Person.html#getHand--">getHand</a></span>()</code>&nbsp;</td> +<td class="colLast"><span class="typeNameLabel">Person.</span><code><span class="memberNameLink"><a href="../../model/Person.html#getHand--">getHand</a></span>()</code> +<div class="block">Returns the hand of the person.</div> +</td> </tr> </tbody> </table> @@ -118,7 +120,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="typeNameLabel">Person.</span><code><span class="memberNameLink"><a href="../../model/Person.html#setHand-controller.Hand-">setHand</a></span>(<a href="../../controller/Hand.html" title="class in controller">Hand</a>&nbsp;hand)</code>&nbsp;</td> +<td class="colLast"><span class="typeNameLabel">Person.</span><code><span class="memberNameLink"><a href="../../model/Person.html#setHand-controller.Hand-">setHand</a></span>(<a href="../../controller/Hand.html" title="class in controller">Hand</a>&nbsp;hand)</code> +<div class="block">Sets the hand of the person.</div> +</td> </tr> </tbody> </table> diff --git a/docs/controller/class-use/LoginController.html b/docs/controller/class-use/LoginController.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class controller.LoginController</title> +<title>Uses of Class controller.LoginController (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class controller.LoginController"; + parent.document.title="Uses of Class controller.LoginController (librejack)"; } } catch(err) { diff --git a/docs/controller/package-frame.html b/docs/controller/package-frame.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>controller</title> +<title>controller (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> diff --git a/docs/controller/package-summary.html b/docs/controller/package-summary.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>controller</title> +<title>controller (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="controller"; + parent.document.title="controller (librejack)"; } } catch(err) { @@ -86,7 +86,9 @@ <tr class="altColor"> <td class="colFirst"><a href="../controller/Controller.html" title="class in controller">Controller</a></td> <td class="colLast"> -<div class="block">Handles most of the game logic.</div> +<div class="block"> + The Controller class is responsible for handling most of the game logic for a + Blackjack game.</div> </td> </tr> <tr class="rowColor"> @@ -99,7 +101,8 @@ <tr class="altColor"> <td class="colFirst"><a href="../controller/LoginController.html" title="class in controller">LoginController</a></td> <td class="colLast"> -<div class="block">Controller for handling user login.</div> +<div class="block"> + Controller for handling user login.</div> </td> </tr> </tbody> diff --git a/docs/controller/package-tree.html b/docs/controller/package-tree.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>controller Class Hierarchy</title> +<title>controller Class Hierarchy (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="controller Class Hierarchy"; + parent.document.title="controller Class Hierarchy (librejack)"; } } catch(err) { diff --git a/docs/controller/package-use.html b/docs/controller/package-use.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Package controller</title> +<title>Uses of Package controller (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package controller"; + parent.document.title="Uses of Package controller (librejack)"; } } catch(err) { diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Deprecated List</title> +<title>Deprecated List (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deprecated List"; + parent.document.title="Deprecated List (librejack)"; } } catch(err) { diff --git a/docs/help-doc.html b/docs/help-doc.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>API Help</title> +<title>API Help (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="API Help"; + parent.document.title="API Help (librejack)"; } } catch(err) { diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>A-Index</title> +<title>A-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="A-Index"; + parent.document.title="A-Index (librejack)"; } } catch(err) { @@ -77,7 +77,7 @@ <dl> <dt><span class="memberNameLink"><a href="../model/Deck.html#addCard-model.Card-">addCard(Card)</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> -<div class="block">Method to add a card to the deck.</div> +<div class="block">Adds a card to the deck.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#addCards-java.util.ArrayList-">addCards(ArrayList&lt;Card&gt;)</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>P-Index</title> +<title>P-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="P-Index"; + parent.document.title="P-Index (librejack)"; } } catch(err) { @@ -77,15 +77,17 @@ <dl> <dt><a href="../model/Person.html" title="class in model"><span class="typeNameLink">Person</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">Parent class of the Player and Dealer Objects.</div> +<div class="block"> + Parent class of the Player and Dealer Objects.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#Person--">Person()</a></span> - Constructor for class model.<a href="../model/Person.html" title="class in model">Person</a></dt> <dd> -<div class="block">Creates a person.</div> +<div class="block">Creates a person with an empty hand and no name.</div> </dd> <dt><a href="../model/Player.html" title="class in model"><span class="typeNameLink">Player</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">Represents a player in a Blackjack game.</div> +<div class="block"> + Represents a player in a blackjack game.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Player.html#Player--">Player()</a></span> - Constructor for class model.<a href="../model/Player.html" title="class in model">Player</a></dt> <dd> @@ -98,9 +100,14 @@ <dt><span class="memberNameLink"><a href="../view/MainGUI.html#printDealerHand--">printDealerHand()</a></span> - Method in class view.<a href="../view/MainGUI.html" title="class in view">MainGUI</a></dt> <dd>&nbsp;</dd> <dt><span class="memberNameLink"><a href="../model/Dealer.html#printFirstCardValue--">printFirstCardValue()</a></span> - Method in class model.<a href="../model/Dealer.html" title="class in model">Dealer</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns a string representation of the value of the dealer's first card + in their hand.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Dealer.html#printFirstHand--">printFirstHand()</a></span> - Method in class model.<a href="../model/Dealer.html" title="class in model">Dealer</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns a string representation of the dealer's first card in their hand.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Person.html#printHand--">printHand()</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> <dd> <div class="block">Prints a formatted version of the person's hand.</div> diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>R-Index</title> +<title>R-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="R-Index"; + parent.document.title="R-Index (librejack)"; } } catch(err) { diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>S-Index</title> +<title>S-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="S-Index"; + parent.document.title="S-Index (librejack)"; } } catch(err) { @@ -76,21 +76,29 @@ <h2 class="title">S</h2> <dl> <dt><span class="memberNameLink"><a href="../controller/Controller.html#setBalance-double-">setBalance(double)</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Sets the current player's balance.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Player.html#setBalance-double-">setBalance(double)</a></span> - Method in class model.<a href="../model/Player.html" title="class in model">Player</a></dt> <dd> <div class="block">Sets the player's balance and stores it in a file.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#setBet-double-">setBet(double)</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Sets the current player's bet.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Person.html#setHand-controller.Hand-">setHand(Hand)</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Sets the hand of the person.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#setLosses-int-">setLosses(int)</a></span> - Method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> <div class="block">Sets the number of losses.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#setName-java.lang.String-">setName(String)</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Sets the name of the person.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#setPushes-int-">setPushes(int)</a></span> - Method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> <div class="block">Sets the number of pushes (ties).</div> @@ -101,15 +109,17 @@ </dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#shuffle--">shuffle()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> -<div class="block">Shuffles deck.</div> +<div class="block">Shuffles deck using a temporary deck for storing cards in random order.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#startRound--">startRound()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> <dd> -<div class="block">Handles logic for each round.</div> +<div class="block"> + Starts a new round of the game.</div> </dd> <dt><a href="../model/Statistics.html" title="class in model"><span class="typeNameLink">Statistics</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">The Statistics class represents a set of statistics for a blackjack game.</div> +<div class="block"> + The Statistics class represents a set of statistics for a blackjack game.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#Statistics--">Statistics()</a></span> - Constructor for class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>T-Index</title> +<title>T-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="T-Index"; + parent.document.title="T-Index (librejack)"; } } catch(err) { @@ -84,15 +84,26 @@ <div class="block">Adds a card from the deck to the hand.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Hand.html#toString--">toString()</a></span> - Method in class controller.<a href="../controller/Hand.html" title="class in controller">Hand</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns a string representation of the current hand.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Card.Rank.html#toString--">toString()</a></span> - Method in enum model.<a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns the name of the rank as a string.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Card.Suit.html#toString--">toString()</a></span> - Method in enum model.<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns the name of the suit as a string.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Card.html#toString--">toString()</a></span> - Method in class model.<a href="../model/Card.html" title="class in model">Card</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns a String representation of the Card object, including the rank + and suit of the card, as well as its value in parentheses.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#toString--">toString()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns a String representation of the Deck object.</div> +</dd> </dl> <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">G</a>&nbsp;<a href="index-6.html">H</a>&nbsp;<a href="index-7.html">I</a>&nbsp;<a href="index-8.html">L</a>&nbsp;<a href="index-9.html">M</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">V</a>&nbsp;</div> <!-- ======= START OF BOTTOM NAVBAR ====== --> diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>V-Index</title> +<title>V-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="V-Index"; + parent.document.title="V-Index (librejack)"; } } catch(err) { diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>C-Index</title> +<title>C-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="C-Index"; + parent.document.title="C-Index (librejack)"; } } catch(err) { @@ -77,37 +77,45 @@ <dl> <dt><span class="memberNameLink"><a href="../controller/Hand.html#calculateValue--">calculateValue()</a></span> - Method in class controller.<a href="../controller/Hand.html" title="class in controller">Hand</a></dt> <dd> -<div class="block">Method to calculate the value of a hand.</div> +<div class="block">Calculates the value of a hand.</div> </dd> <dt><a href="../model/Card.html" title="class in model"><span class="typeNameLink">Card</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">Represents a card and handles card operations.</div> +<div class="block">Represents a standard playing card and handles card operations.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Card.html#Card-model.Card.Suit-model.Card.Rank-">Card(Card.Suit, Card.Rank)</a></span> - Constructor for class model.<a href="../model/Card.html" title="class in model">Card</a></dt> <dd> -<div class="block">Card Constructor: Creates a card given a suit and rank.</div> +<div class="block">Creates a new Card object with the specified suit and rank.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Card.html#Card-model.Card-">Card(Card)</a></span> - Constructor for class model.<a href="../model/Card.html" title="class in model">Card</a></dt> <dd> -<div class="block">Card Constructor: Creates a new card as a copy of another card.</div> +<div class="block">Creates a new Card object as a copy of another Card object.</div> </dd> <dt><a href="../model/Card.Rank.html" title="enum in model"><span class="typeNameLink">Card.Rank</span></a> - Enum in <a href="../model/package-summary.html">model</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Represents the thirteen possible ranks in a standard playing card deck.</div> +</dd> <dt><a href="../model/Card.Suit.html" title="enum in model"><span class="typeNameLink">Card.Suit</span></a> - Enum in <a href="../model/package-summary.html">model</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Represents the four possible suits in a standard playing card deck.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#cardsLeft--">cardsLeft()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd>&nbsp;</dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#checkWhoWins--">checkWhoWins()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Checks who wins the game and returns a message indicating the result.</div> +</dd> <dt><a href="../controller/package-summary.html">controller</a> - package controller</dt> <dd>&nbsp;</dd> <dt><a href="../controller/Controller.html" title="class in controller"><span class="typeNameLink">Controller</span></a> - Class in <a href="../controller/package-summary.html">controller</a></dt> <dd> -<div class="block">Handles most of the game logic.</div> +<div class="block"> + The Controller class is responsible for handling most of the game logic for a + Blackjack game.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#Controller--">Controller()</a></span> - Constructor for class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> <dd> -<div class="block">Controller Constructor: Initializes score to 0.</div> +<div class="block">Creates a new instance of the Controller class.</div> </dd> </dl> <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">G</a>&nbsp;<a href="index-6.html">H</a>&nbsp;<a href="index-7.html">I</a>&nbsp;<a href="index-8.html">L</a>&nbsp;<a href="index-9.html">M</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">V</a>&nbsp;</div> diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>D-Index</title> +<title>D-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="D-Index"; + parent.document.title="D-Index (librejack)"; } } catch(err) { @@ -77,16 +77,16 @@ <dl> <dt><a href="../model/Dealer.html" title="class in model"><span class="typeNameLink">Dealer</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">Handles dealer specific operations, such as drawing cards to 16 and standing - on 17 or above.</div> +<div class="block">Represents a dealer in a card game and handles dealer-specific operations.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Dealer.html#Dealer--">Dealer()</a></span> - Constructor for class model.<a href="../model/Dealer.html" title="class in model">Dealer</a></dt> <dd> -<div class="block">Creates a new dealer.</div> +<div class="block">Creates a new dealer with the default name "Dealer".</div> </dd> <dt><a href="../model/Deck.html" title="class in model"><span class="typeNameLink">Deck</span></a> - Class in <a href="../model/package-summary.html">model</a></dt> <dd> -<div class="block">Holds multiple cards and performs operations such as shuffling the deck.</div> +<div class="block"> + Holds multiple cards and performs operations such as shuffling the deck.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#Deck--">Deck()</a></span> - Constructor for class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> @@ -94,7 +94,8 @@ </dd> <dt><span class="memberNameLink"><a href="../controller/Hand.html#discardHandToDeck-model.Deck-">discardHandToDeck(Deck)</a></span> - Method in class controller.<a href="../controller/Hand.html" title="class in controller">Hand</a></dt> <dd> -<div class="block">Discards hand to deck.</div> +<div class="block">Discards the current hand and adds its cards to the specified discard + deck.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#displayDealerFirstCard--">displayDealerFirstCard()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> <dd>&nbsp;</dd> diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>E-Index</title> +<title>E-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="E-Index"; + parent.document.title="E-Index (librejack)"; } } catch(err) { @@ -77,7 +77,7 @@ <dl> <dt><span class="memberNameLink"><a href="../model/Deck.html#emptyDeck--">emptyDeck()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> -<div class="block">Mehtod to empty the deck.</div> +<div class="block">Removes all Card objects from the deck.</div> </dd> </dl> <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">G</a>&nbsp;<a href="index-6.html">H</a>&nbsp;<a href="index-7.html">I</a>&nbsp;<a href="index-8.html">L</a>&nbsp;<a href="index-9.html">M</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">V</a>&nbsp;</div> diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>G-Index</title> +<title>G-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="G-Index"; + parent.document.title="G-Index (librejack)"; } } catch(err) { @@ -76,37 +76,53 @@ <h2 class="title">G</h2> <dl> <dt><span class="memberNameLink"><a href="../controller/Controller.html#getBalance--">getBalance()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the current player's balance.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Player.html#getBalance--">getBalance()</a></span> - Method in class model.<a href="../model/Player.html" title="class in model">Player</a></dt> <dd> <div class="block">Gets the player's current balance from a file.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#getBet--">getBet()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the current player's bet.</div> +</dd> <dt><span class="memberNameLink"><a href="../controller/Hand.html#getCard-int-">getCard(int)</a></span> - Method in class controller.<a href="../controller/Hand.html" title="class in controller">Hand</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the card at a specific index.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#getCards--">getCards()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> <div class="block">Returns arraylist containing all the cards in the deck.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#getHand--">getHand()</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns the hand of the person.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#getLosses--">getLosses()</a></span> - Method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> <div class="block">Gets the number of losses.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#getName--">getName()</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Returns the name of the person.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#getPushes--">getPushes()</a></span> - Method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> <div class="block">Gets the number of pushes (ties).</div> </dd> <dt><span class="memberNameLink"><a href="../model/Card.html#getRank--">getRank()</a></span> - Method in class model.<a href="../model/Card.html" title="class in model">Card</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the rank of the card.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Card.html#getSuit--">getSuit()</a></span> - Method in class model.<a href="../model/Card.html" title="class in model">Card</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the suit of the card.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Card.html#getValue--">getValue()</a></span> - Method in class model.<a href="../model/Card.html" title="class in model">Card</a></dt> -<dd>&nbsp;</dd> +<dd> +<div class="block">Gets the value of the card.</div> +</dd> <dt><span class="memberNameLink"><a href="../model/Statistics.html#getWins--">getWins()</a></span> - Method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> <div class="block">Gets the number of wins.</div> diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>H-Index</title> +<title>H-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="H-Index"; + parent.document.title="H-Index (librejack)"; } } catch(err) { @@ -82,11 +82,11 @@ </dd> <dt><span class="memberNameLink"><a href="../controller/Hand.html#Hand--">Hand()</a></span> - Constructor for class controller.<a href="../controller/Hand.html" title="class in controller">Hand</a></dt> <dd> -<div class="block">Hand Constructor: Creates empty hand.</div> +<div class="block">Creates a new empty Hand object.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#hasBlackjack--">hasBlackjack()</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> <dd> -<div class="block">Checks if a person has blackjack.</div> +<div class="block">Checks if the person has blackjack.</div> </dd> <dt><span class="memberNameLink"><a href="../model/Deck.html#hasCards--">hasCards()</a></span> - Method in class model.<a href="../model/Deck.html" title="class in model">Deck</a></dt> <dd> @@ -94,7 +94,7 @@ </dd> <dt><span class="memberNameLink"><a href="../model/Person.html#hit-model.Deck-model.Deck-">hit(Deck, Deck)</a></span> - Method in class model.<a href="../model/Person.html" title="class in model">Person</a></dt> <dd> -<div class="block">Checks if deck has cards and reloads deck if it ran out.</div> +<div class="block">Draws a card from the deck and adds it to the person's hand.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/Controller.html#hitPlayer--">hitPlayer()</a></span> - Method in class controller.<a href="../controller/Controller.html" title="class in controller">Controller</a></dt> <dd> diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>I-Index</title> +<title>I-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="I-Index"; + parent.document.title="I-Index (librejack)"; } } catch(err) { diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>L-Index</title> +<title>L-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="L-Index"; + parent.document.title="L-Index (librejack)"; } } catch(err) { @@ -77,12 +77,14 @@ <dl> <dt><span class="memberNameLink"><a href="../model/Statistics.html#load--">load()</a></span> - Static method in class model.<a href="../model/Statistics.html" title="class in model">Statistics</a></dt> <dd> -<div class="block">This static method loads the statistics from the CSV file located at the +<div class="block"> + This static method loads the statistics from the CSV file located at the path defined by the CSV_FILE constant in the Statistics class.</div> </dd> <dt><a href="../controller/LoginController.html" title="class in controller"><span class="typeNameLink">LoginController</span></a> - Class in <a href="../controller/package-summary.html">controller</a></dt> <dd> -<div class="block">Controller for handling user login.</div> +<div class="block"> + Controller for handling user login.</div> </dd> <dt><span class="memberNameLink"><a href="../controller/LoginController.html#LoginController--">LoginController()</a></span> - Constructor for class controller.<a href="../controller/LoginController.html" title="class in controller">LoginController</a></dt> <dd>&nbsp;</dd> diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>M-Index</title> +<title>M-Index (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="M-Index"; + parent.document.title="M-Index (librejack)"; } } catch(err) { diff --git a/docs/index.html b/docs/index.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Generated Documentation (Untitled)</title> +<title>librejack</title> <script type="text/javascript"> tmpTargetPage = "" + window.location.search; if (tmpTargetPage != "" && tmpTargetPage != "undefined") diff --git a/docs/model/Card.Rank.html b/docs/model/Card.Rank.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Card.Rank</title> +<title>Card.Rank (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Card.Rank"; + parent.document.title="Card.Rank (librejack)"; } } catch(err) { @@ -125,6 +125,9 @@ var activeTableTab = "activeTableTab"; <br> <pre>public static enum <span class="typeNameLabel">Card.Rank</span> extends java.lang.Enum&lt;<a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a>&gt;</pre> +<div class="block">Represents the thirteen possible ranks in a standard playing card deck. + + Each rank has a name and a value.</div> </li> </ul> </div> @@ -217,7 +220,9 @@ extends java.lang.Enum&lt;<a href="../model/Card.Rank.html" title="enum in model </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Rank.html#toString--">toString</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Rank.html#toString--">toString</a></span>()</code> +<div class="block">Returns the name of the rank as a string.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></code></td> @@ -452,9 +457,12 @@ not permitted.)</div> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> +<div class="block">Returns the name of the rank as a string.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Enum&lt;<a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a>&gt;</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the rank</dd> </dl> </li> </ul> diff --git a/docs/model/Card.Suit.html b/docs/model/Card.Suit.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Card.Suit</title> +<title>Card.Suit (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Card.Suit"; + parent.document.title="Card.Suit (librejack)"; } } catch(err) { @@ -125,6 +125,7 @@ var activeTableTab = "activeTableTab"; <br> <pre>public static enum <span class="typeNameLabel">Card.Suit</span> extends java.lang.Enum&lt;<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a>&gt;</pre> +<div class="block">Represents the four possible suits in a standard playing card deck.</div> </li> </ul> </div> @@ -190,7 +191,9 @@ extends java.lang.Enum&lt;<a href="../model/Card.Suit.html" title="enum in model </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Suit.html#toString--">toString</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Suit.html#toString--">toString</a></span>()</code> +<div class="block">Returns the name of the suit as a string.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></code></td> @@ -344,9 +347,12 @@ not permitted.)</div> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> +<div class="block">Returns the name of the suit as a string.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Enum&lt;<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a>&gt;</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the suit</dd> </dl> </li> </ul> diff --git a/docs/model/Card.html b/docs/model/Card.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Card</title> +<title>Card (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Card"; + parent.document.title="Card (librejack)"; } } catch(err) { @@ -112,7 +112,12 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Card</span> extends java.lang.Object</pre> -<div class="block">Represents a card and handles card operations.</div> +<div class="block">Represents a standard playing card and handles card operations.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> @@ -133,11 +138,15 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>static class&nbsp;</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></span></code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></span></code> +<div class="block">Represents the thirteen possible ranks in a standard playing card deck.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static class&nbsp;</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></span></code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></span></code> +<div class="block">Represents the four possible suits in a standard playing card deck.</div> +</td> </tr> </table> </li> @@ -156,12 +165,12 @@ extends java.lang.Object</pre> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../model/Card.html#Card-model.Card.Suit-model.Card.Rank-">Card</a></span>(<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a>&nbsp;suit, <a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a>&nbsp;rank)</code> -<div class="block">Card Constructor: Creates a card given a suit and rank.</div> +<div class="block">Creates a new Card object with the specified suit and rank.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../model/Card.html#Card-model.Card-">Card</a></span>(<a href="../model/Card.html" title="class in model">Card</a>&nbsp;card)</code> -<div class="block">Card Constructor: Creates a new card as a copy of another card.</div> +<div class="block">Creates a new Card object as a copy of another Card object.</div> </td> </tr> </table> @@ -181,19 +190,28 @@ extends java.lang.Object</pre> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getRank--">getRank</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getRank--">getRank</a></span>()</code> +<div class="block">Gets the rank of the card.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getSuit--">getSuit</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getSuit--">getSuit</a></span>()</code> +<div class="block">Gets the suit of the card.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getValue--">getValue</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#getValue--">getValue</a></span>()</code> +<div class="block">Gets the value of the card.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#toString--">toString</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Card.html#toString--">toString</a></span>()</code> +<div class="block">Returns a String representation of the Card object, including the rank + and suit of the card, as well as its value in parentheses.</div> +</td> </tr> </table> <ul class="blockList"> @@ -225,7 +243,7 @@ extends java.lang.Object</pre> <h4>Card</h4> <pre>public&nbsp;Card(<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a>&nbsp;suit, <a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a>&nbsp;rank)</pre> -<div class="block">Card Constructor: Creates a card given a suit and rank.</div> +<div class="block">Creates a new Card object with the specified suit and rank.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>suit</code> - Card suit</dd> @@ -240,7 +258,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>Card</h4> <pre>public&nbsp;Card(<a href="../model/Card.html" title="class in model">Card</a>&nbsp;card)</pre> -<div class="block">Card Constructor: Creates a new card as a copy of another card.</div> +<div class="block">Creates a new Card object as a copy of another Card object.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>card</code> - card to be added</dd> @@ -262,6 +280,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getValue</h4> <pre>public&nbsp;int&nbsp;getValue()</pre> +<div class="block">Gets the value of the card.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the card.</dd> +</dl> </li> </ul> <a name="getSuit--"> @@ -271,6 +294,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getSuit</h4> <pre>public&nbsp;<a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a>&nbsp;getSuit()</pre> +<div class="block">Gets the suit of the card.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The suit of the card.</dd> +</dl> </li> </ul> <a name="getRank--"> @@ -280,6 +308,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getRank</h4> <pre>public&nbsp;<a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a>&nbsp;getRank()</pre> +<div class="block">Gets the rank of the card.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The rank of the card.</dd> +</dl> </li> </ul> <a name="toString--"> @@ -289,9 +322,13 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> +<div class="block">Returns a String representation of the Card object, including the rank + and suit of the card, as well as its value in parentheses.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a String representation of the Card object</dd> </dl> </li> </ul> diff --git a/docs/model/Dealer.html b/docs/model/Dealer.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Dealer</title> +<title>Dealer (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Dealer"; + parent.document.title="Dealer (librejack)"; } } catch(err) { @@ -117,8 +117,18 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Dealer</span> extends <a href="../model/Person.html" title="class in model">Person</a></pre> -<div class="block">Handles dealer specific operations, such as drawing cards to 16 and standing - on 17 or above.</div> +<div class="block">Represents a dealer in a card game and handles dealer-specific operations. + + <p> + This class extends the <a href="../model/Person.html" title="class in model"><code>Person</code></a> class, which contains shared methods + and properties between players and dealers.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../model/Person.html" title="class in model"><code>Person</code></a></dd> +</dl> </li> </ul> </div> @@ -138,7 +148,7 @@ extends <a href="../model/Person.html" title="class in model">Person</a></pre> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../model/Dealer.html#Dealer--">Dealer</a></span>()</code> -<div class="block">Creates a new dealer.</div> +<div class="block">Creates a new dealer with the default name "Dealer".</div> </td> </tr> </table> @@ -158,11 +168,16 @@ extends <a href="../model/Person.html" title="class in model">Person</a></pre> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Dealer.html#printFirstCardValue--">printFirstCardValue</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Dealer.html#printFirstCardValue--">printFirstCardValue</a></span>()</code> +<div class="block">Returns a string representation of the value of the dealer's first card + in their hand.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Dealer.html#printFirstHand--">printFirstHand</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Dealer.html#printFirstHand--">printFirstHand</a></span>()</code> +<div class="block">Returns a string representation of the dealer's first card in their hand.</div> +</td> </tr> </table> <ul class="blockList"> @@ -200,7 +215,7 @@ extends <a href="../model/Person.html" title="class in model">Person</a></pre> <li class="blockList"> <h4>Dealer</h4> <pre>public&nbsp;Dealer()</pre> -<div class="block">Creates a new dealer.</div> +<div class="block">Creates a new dealer with the default name "Dealer".</div> </li> </ul> </li> @@ -218,6 +233,11 @@ extends <a href="../model/Person.html" title="class in model">Person</a></pre> <li class="blockList"> <h4>printFirstHand</h4> <pre>public&nbsp;java.lang.String&nbsp;printFirstHand()</pre> +<div class="block">Returns a string representation of the dealer's first card in their hand.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the first card in the dealer's hand as a String</dd> +</dl> </li> </ul> <a name="printFirstCardValue--"> @@ -227,6 +247,12 @@ extends <a href="../model/Person.html" title="class in model">Person</a></pre> <li class="blockList"> <h4>printFirstCardValue</h4> <pre>public&nbsp;java.lang.String&nbsp;printFirstCardValue()</pre> +<div class="block">Returns a string representation of the value of the dealer's first card + in their hand.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value of the first card in the dealer's hand as a String</dd> +</dl> </li> </ul> </li> diff --git a/docs/model/Deck.html b/docs/model/Deck.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Deck</title> +<title>Deck (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deck"; + parent.document.title="Deck (librejack)"; } } catch(err) { @@ -112,7 +112,18 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Deck</span> extends java.lang.Object</pre> -<div class="block">Holds multiple cards and performs operations such as shuffling the deck.</div> +<div class="block"><p> + Holds multiple cards and performs operations such as shuffling the deck.</p> + <p> + This class is responsible for creating a deck, populating it with 52 cards, + shuffling the deck, adding cards to the deck, removing a card from the deck, + checking if the deck has any cards left, emptying the deck, and returning the + deck's current size.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> @@ -153,7 +164,7 @@ extends java.lang.Object</pre> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Deck.html#addCard-model.Card-">addCard</a></span>(<a href="../model/Card.html" title="class in model">Card</a>&nbsp;inCard)</code> -<div class="block">Method to add a card to the deck.</div> +<div class="block">Adds a card to the deck.</div> </td> </tr> <tr id="i1" class="rowColor"> @@ -169,7 +180,7 @@ extends java.lang.Object</pre> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Deck.html#emptyDeck--">emptyDeck</a></span>()</code> -<div class="block">Mehtod to empty the deck.</div> +<div class="block">Removes all Card objects from the deck.</div> </td> </tr> <tr id="i4" class="altColor"> @@ -199,7 +210,7 @@ extends java.lang.Object</pre> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Deck.html#shuffle--">shuffle</a></span>()</code> -<div class="block">Shuffles deck.</div> +<div class="block">Shuffles deck using a temporary deck for storing cards in random order.</div> </td> </tr> <tr id="i9" class="rowColor"> @@ -210,7 +221,9 @@ extends java.lang.Object</pre> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Deck.html#toString--">toString</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Deck.html#toString--">toString</a></span>()</code> +<div class="block">Returns a String representation of the Deck object.</div> +</td> </tr> </table> <ul class="blockList"> @@ -269,7 +282,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>shuffle</h4> <pre>public&nbsp;void&nbsp;shuffle()</pre> -<div class="block">Shuffles deck.</div> +<div class="block">Shuffles deck using a temporary deck for storing cards in random order.</div> </li> </ul> <a name="addCard-model.Card-"> @@ -279,7 +292,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>addCard</h4> <pre>public&nbsp;void&nbsp;addCard(<a href="../model/Card.html" title="class in model">Card</a>&nbsp;inCard)</pre> -<div class="block">Method to add a card to the deck.</div> +<div class="block">Adds a card to the deck.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>inCard</code> - card the be added</dd> @@ -296,7 +309,7 @@ extends java.lang.Object</pre> <div class="block">Takes copy of first card from deck and removes card from deck.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>cardToTake card that was removed</dd> +<dd>the card that was removed</dd> </dl> </li> </ul> @@ -310,7 +323,7 @@ extends java.lang.Object</pre> <div class="block">Makes sure the deck we're hitting from has cards in it.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>true (if the deck has cards in)</dd> +<dd>true if the deck has cards in or false if the deck is empty</dd> </dl> </li> </ul> @@ -321,7 +334,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>emptyDeck</h4> <pre>public&nbsp;void&nbsp;emptyDeck()</pre> -<div class="block">Mehtod to empty the deck.</div> +<div class="block">Removes all Card objects from the deck.</div> </li> </ul> <a name="addCards-java.util.ArrayList-"> @@ -360,7 +373,7 @@ extends java.lang.Object</pre> <h4>reloadDeckFromDiscard</h4> <pre>public&nbsp;void&nbsp;reloadDeckFromDiscard(<a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;discard)</pre> <div class="block">Take all cards from discarded deck and place them in this deck, shuffled. - Clear the old deck</div> + Clear the old deck.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>discard</code> - the deck cards are coming from</dd> @@ -376,7 +389,7 @@ extends java.lang.Object</pre> <pre>public&nbsp;int&nbsp;cardsLeft()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>deck.size() number of cards left in the deck.</dd> +<dd>number of cards left in the deck.</dd> </dl> </li> </ul> @@ -387,9 +400,13 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> +<div class="block">Returns a String representation of the Deck object. The String contains a + list of all the cards in the deck, with each card on a new line.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a String representation of the Deck object</dd> </dl> </li> </ul> diff --git a/docs/model/Person.html b/docs/model/Person.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Person</title> +<title>Person (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Person"; + parent.document.title="Person (librejack)"; } } catch(err) { @@ -116,7 +116,19 @@ var activeTableTab = "activeTableTab"; <br> <pre>public abstract class <span class="typeNameLabel">Person</span> extends java.lang.Object</pre> -<div class="block">Parent class of the Player and Dealer Objects.</div> +<div class="block"><p> + Parent class of the Player and Dealer Objects.</p> + <p> + Contains information about a person in a blackjack game, such as their name + and hand.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../model/Player.html" title="class in model"><code>Player</code></a>, +<a href="../model/Dealer.html" title="class in model"><code>Dealer</code></a></dd> +</dl> </li> </ul> </div> @@ -136,7 +148,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../model/Person.html#Person--">Person</a></span>()</code> -<div class="block">Creates a person.</div> +<div class="block">Creates a person with an empty hand and no name.</div> </td> </tr> </table> @@ -156,23 +168,27 @@ extends java.lang.Object</pre> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../controller/Hand.html" title="class in controller">Hand</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#getHand--">getHand</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#getHand--">getHand</a></span>()</code> +<div class="block">Returns the hand of the person.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#getName--">getName</a></span>()</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#getName--">getName</a></span>()</code> +<div class="block">Returns the name of the person.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#hasBlackjack--">hasBlackjack</a></span>()</code> -<div class="block">Checks if a person has blackjack.</div> +<div class="block">Checks if the person has blackjack.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#hit-model.Deck-model.Deck-">hit</a></span>(<a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;deck, <a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;discard)</code> -<div class="block">Checks if deck has cards and reloads deck if it ran out.</div> +<div class="block">Draws a card from the deck and adds it to the person's hand.</div> </td> </tr> <tr id="i4" class="altColor"> @@ -183,11 +199,15 @@ extends java.lang.Object</pre> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#setHand-controller.Hand-">setHand</a></span>(<a href="../controller/Hand.html" title="class in controller">Hand</a>&nbsp;hand)</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#setHand-controller.Hand-">setHand</a></span>(<a href="../controller/Hand.html" title="class in controller">Hand</a>&nbsp;hand)</code> +<div class="block">Sets the hand of the person.</div> +</td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../model/Person.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code> +<div class="block">Sets the name of the person.</div> +</td> </tr> </table> <ul class="blockList"> @@ -218,7 +238,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>Person</h4> <pre>public&nbsp;Person()</pre> -<div class="block">Creates a person.</div> +<div class="block">Creates a person with an empty hand and no name.</div> </li> </ul> </li> @@ -236,6 +256,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getHand</h4> <pre>public&nbsp;<a href="../controller/Hand.html" title="class in controller">Hand</a>&nbsp;getHand()</pre> +<div class="block">Returns the hand of the person.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the hand of the person</dd> +</dl> </li> </ul> <a name="setHand-controller.Hand-"> @@ -245,6 +270,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>setHand</h4> <pre>public&nbsp;void&nbsp;setHand(<a href="../controller/Hand.html" title="class in controller">Hand</a>&nbsp;hand)</pre> +<div class="block">Sets the hand of the person.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hand</code> - the hand to set</dd> +</dl> </li> </ul> <a name="getName--"> @@ -254,6 +284,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getName</h4> <pre>public&nbsp;java.lang.String&nbsp;getName()</pre> +<div class="block">Returns the name of the person.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the person</dd> +</dl> </li> </ul> <a name="setName-java.lang.String-"> @@ -263,6 +298,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>setName</h4> <pre>public&nbsp;void&nbsp;setName(java.lang.String&nbsp;name)</pre> +<div class="block">Sets the name of the person.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name to set</dd> +</dl> </li> </ul> <a name="hasBlackjack--"> @@ -272,10 +312,10 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>hasBlackjack</h4> <pre>public&nbsp;boolean&nbsp;hasBlackjack()</pre> -<div class="block">Checks if a person has blackjack.</div> +<div class="block">Checks if the person has blackjack.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>true (if player has a blackjack)</dd> +<dd>true if the person has a blackjack, false otherwise</dd> </dl> </li> </ul> @@ -287,6 +327,10 @@ extends java.lang.Object</pre> <h4>printHand</h4> <pre>public&nbsp;java.lang.String&nbsp;printHand()</pre> <div class="block">Prints a formatted version of the person's hand.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a formatted string representing the person's hand</dd> +</dl> </li> </ul> <a name="hit-model.Deck-model.Deck-"> @@ -297,11 +341,12 @@ extends java.lang.Object</pre> <h4>hit</h4> <pre>public&nbsp;void&nbsp;hit(<a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;deck, <a href="../model/Deck.html" title="class in model">Deck</a>&nbsp;discard)</pre> -<div class="block">Checks if deck has cards and reloads deck if it ran out.</div> +<div class="block">Draws a card from the deck and adds it to the person's hand. If the deck + has no cards, the deck is reloaded from the discard pile.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>deck</code> - deck to draw from</dd> -<dd><code>discard</code> - deck to discard to</dd> +<dd><code>deck</code> - the deck to draw from</dd> +<dd><code>discard</code> - the discard pile to reload from if the deck is empty</dd> </dl> </li> </ul> diff --git a/docs/model/Player.html b/docs/model/Player.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Player</title> +<title>Player (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Player"; + parent.document.title="Player (librejack)"; } } catch(err) { @@ -117,7 +117,21 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Player</span> extends <a href="../model/Person.html" title="class in model">Person</a></pre> -<div class="block">Represents a player in a Blackjack game.</div> +<div class="block"><p> + Represents a player in a blackjack game. A player has a name and a hand of + cards. They can take actions such as hitting, standing, and doubling down. + They can also make bets and receive payouts.</p> + + <p> + This class extends the <a href="../model/Person.html" title="class in model"><code>Person</code></a> class, which contains shared methods + and properties between players and dealers.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../model/Person.html" title="class in model"><code>Person</code></a></dd> +</dl> </li> </ul> </div> diff --git a/docs/model/Statistics.html b/docs/model/Statistics.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Statistics</title> +<title>Statistics (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Statistics"; + parent.document.title="Statistics (librejack)"; } } catch(err) { @@ -112,12 +112,22 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">Statistics</span> extends java.lang.Object</pre> -<div class="block">The Statistics class represents a set of statistics for a blackjack game. - Statistics are stored in a CSV file with the following format: - Column 1: - number of wins - Column 2: number of losses - Column 3: number of pushes - (ties) +<div class="block"><p> + The Statistics class represents a set of statistics for a blackjack game. + Statistics are stored in a CSV file with the following format: + <ul> + <li><b>Column 1:</b> number of wins</li> + <li><b>Column 2:</b> number of losses</li> + <li><b>Column 3:</b> number of pushes(ties)</li> + </ul></p> - The file is named 'statistics.csv' and is stored in the 'db/' directory.</div> + <p> + The file is named `statistics.csv` and is stored in the 'db/' directory.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> +</dl> </li> </ul> </div> @@ -204,7 +214,8 @@ extends java.lang.Object</pre> <tr id="i6" class="altColor"> <td class="colFirst"><code>static <a href="../model/Statistics.html" title="class in model">Statistics</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/Statistics.html#load--">load</a></span>()</code> -<div class="block">This static method loads the statistics from the CSV file located at the +<div class="block"> + This static method loads the statistics from the CSV file located at the path defined by the CSV_FILE constant in the Statistics class.</div> </td> </tr> @@ -409,15 +420,19 @@ extends java.lang.Object</pre> <h4>load</h4> <pre>public static&nbsp;<a href="../model/Statistics.html" title="class in model">Statistics</a>&nbsp;load() throws java.io.IOException</pre> -<div class="block">This static method loads the statistics from the CSV file located at the +<div class="block"><p> + This static method loads the statistics from the CSV file located at the path defined by the CSV_FILE constant in the Statistics class. The method - uses a CSVReader object to read the data from the file. If the CSV file - does not have the expected headers, an IOException is thrown. The method - returns a Statistics object with the values read from the CSV file. If an - IOException occurs during the file reading process, it is caught and - ignored. If a CsvValidationException is thrown during the file reading - process, it is handled internally and an empty Statistics object is - returned.</div> + uses a CSVReader object to read the data from the file.</p> + <p> + If the CSV file does not have the expected headers, an IOException is + thrown. The method returns a Statistics object with the values read from + the CSV file.</p> + <p> + If an IOException occurs during the file reading process, it is caught + and ignored. If a CsvValidationException is thrown during the file + reading process, it is handled internally and an empty Statistics object + is returned.</p></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a Statistics object with the values read from the CSV file, or an diff --git a/docs/model/class-use/Card.Rank.html b/docs/model/class-use/Card.Rank.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Card.Rank</title> +<title>Uses of Class model.Card.Rank (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Card.Rank"; + parent.document.title="Uses of Class model.Card.Rank (librejack)"; } } catch(err) { @@ -105,7 +105,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code><a href="../../model/Card.Rank.html" title="enum in model">Card.Rank</a></code></td> -<td class="colLast"><span class="typeNameLabel">Card.</span><code><span class="memberNameLink"><a href="../../model/Card.html#getRank--">getRank</a></span>()</code>&nbsp;</td> +<td class="colLast"><span class="typeNameLabel">Card.</span><code><span class="memberNameLink"><a href="../../model/Card.html#getRank--">getRank</a></span>()</code> +<div class="block">Gets the rank of the card.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../model/Card.Rank.html" title="enum in model">Card.Rank</a></code></td> @@ -131,7 +133,7 @@ the order they are declared.</div> <tr class="altColor"> <td class="colLast"><code><span class="memberNameLink"><a href="../../model/Card.html#Card-model.Card.Suit-model.Card.Rank-">Card</a></span>(<a href="../../model/Card.Suit.html" title="enum in model">Card.Suit</a>&nbsp;suit, <a href="../../model/Card.Rank.html" title="enum in model">Card.Rank</a>&nbsp;rank)</code> -<div class="block">Card Constructor: Creates a card given a suit and rank.</div> +<div class="block">Creates a new Card object with the specified suit and rank.</div> </td> </tr> </tbody> diff --git a/docs/model/class-use/Card.Suit.html b/docs/model/class-use/Card.Suit.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Card.Suit</title> +<title>Uses of Class model.Card.Suit (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Card.Suit"; + parent.document.title="Uses of Class model.Card.Suit (librejack)"; } } catch(err) { @@ -105,7 +105,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code><a href="../../model/Card.Suit.html" title="enum in model">Card.Suit</a></code></td> -<td class="colLast"><span class="typeNameLabel">Card.</span><code><span class="memberNameLink"><a href="../../model/Card.html#getSuit--">getSuit</a></span>()</code>&nbsp;</td> +<td class="colLast"><span class="typeNameLabel">Card.</span><code><span class="memberNameLink"><a href="../../model/Card.html#getSuit--">getSuit</a></span>()</code> +<div class="block">Gets the suit of the card.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../model/Card.Suit.html" title="enum in model">Card.Suit</a></code></td> @@ -131,7 +133,7 @@ the order they are declared.</div> <tr class="altColor"> <td class="colLast"><code><span class="memberNameLink"><a href="../../model/Card.html#Card-model.Card.Suit-model.Card.Rank-">Card</a></span>(<a href="../../model/Card.Suit.html" title="enum in model">Card.Suit</a>&nbsp;suit, <a href="../../model/Card.Rank.html" title="enum in model">Card.Rank</a>&nbsp;rank)</code> -<div class="block">Card Constructor: Creates a card given a suit and rank.</div> +<div class="block">Creates a new Card object with the specified suit and rank.</div> </td> </tr> </tbody> diff --git a/docs/model/class-use/Card.html b/docs/model/class-use/Card.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Card</title> +<title>Uses of Class model.Card (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Card"; + parent.document.title="Uses of Class model.Card (librejack)"; } } catch(err) { @@ -109,7 +109,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code><a href="../../model/Card.html" title="class in model">Card</a></code></td> -<td class="colLast"><span class="typeNameLabel">Hand.</span><code><span class="memberNameLink"><a href="../../controller/Hand.html#getCard-int-">getCard</a></span>(int&nbsp;i)</code>&nbsp;</td> +<td class="colLast"><span class="typeNameLabel">Hand.</span><code><span class="memberNameLink"><a href="../../controller/Hand.html#getCard-int-">getCard</a></span>(int&nbsp;i)</code> +<div class="block">Gets the card at a specific index.</div> +</td> </tr> </tbody> </table> @@ -158,7 +160,7 @@ <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Deck.</span><code><span class="memberNameLink"><a href="../../model/Deck.html#addCard-model.Card-">addCard</a></span>(<a href="../../model/Card.html" title="class in model">Card</a>&nbsp;inCard)</code> -<div class="block">Method to add a card to the deck.</div> +<div class="block">Adds a card to the deck.</div> </td> </tr> </tbody> @@ -186,7 +188,7 @@ <tbody> <tr class="altColor"> <td class="colLast"><code><span class="memberNameLink"><a href="../../model/Card.html#Card-model.Card-">Card</a></span>(<a href="../../model/Card.html" title="class in model">Card</a>&nbsp;card)</code> -<div class="block">Card Constructor: Creates a new card as a copy of another card.</div> +<div class="block">Creates a new Card object as a copy of another Card object.</div> </td> </tr> </tbody> diff --git a/docs/model/class-use/Dealer.html b/docs/model/class-use/Dealer.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Dealer</title> +<title>Uses of Class model.Dealer (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Dealer"; + parent.document.title="Uses of Class model.Dealer (librejack)"; } } catch(err) { diff --git a/docs/model/class-use/Deck.html b/docs/model/class-use/Deck.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Deck</title> +<title>Uses of Class model.Deck (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Deck"; + parent.document.title="Uses of Class model.Deck (librejack)"; } } catch(err) { @@ -110,7 +110,8 @@ <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Hand.</span><code><span class="memberNameLink"><a href="../../controller/Hand.html#discardHandToDeck-model.Deck-">discardHandToDeck</a></span>(<a href="../../model/Deck.html" title="class in model">Deck</a>&nbsp;discardDeck)</code> -<div class="block">Discards hand to deck.</div> +<div class="block">Discards the current hand and adds its cards to the specified discard + deck.</div> </td> </tr> <tr class="rowColor"> @@ -137,7 +138,7 @@ <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Person.</span><code><span class="memberNameLink"><a href="../../model/Person.html#hit-model.Deck-model.Deck-">hit</a></span>(<a href="../../model/Deck.html" title="class in model">Deck</a>&nbsp;deck, <a href="../../model/Deck.html" title="class in model">Deck</a>&nbsp;discard)</code> -<div class="block">Checks if deck has cards and reloads deck if it ran out.</div> +<div class="block">Draws a card from the deck and adds it to the person's hand.</div> </td> </tr> <tr class="rowColor"> diff --git a/docs/model/class-use/Person.html b/docs/model/class-use/Person.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Person</title> +<title>Uses of Class model.Person (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Person"; + parent.document.title="Uses of Class model.Person (librejack)"; } } catch(err) { @@ -106,14 +106,14 @@ <tr class="altColor"> <td class="colFirst"><code>class&nbsp;</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../model/Dealer.html" title="class in model">Dealer</a></span></code> -<div class="block">Handles dealer specific operations, such as drawing cards to 16 and standing - on 17 or above.</div> +<div class="block">Represents a dealer in a card game and handles dealer-specific operations.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>class&nbsp;</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../model/Player.html" title="class in model">Player</a></span></code> -<div class="block">Represents a player in a Blackjack game.</div> +<div class="block"> + Represents a player in a blackjack game.</div> </td> </tr> </tbody> diff --git a/docs/model/class-use/Player.html b/docs/model/class-use/Player.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Player</title> +<title>Uses of Class model.Player (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Player"; + parent.document.title="Uses of Class model.Player (librejack)"; } } catch(err) { diff --git a/docs/model/class-use/Statistics.html b/docs/model/class-use/Statistics.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class model.Statistics</title> +<title>Uses of Class model.Statistics (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class model.Statistics"; + parent.document.title="Uses of Class model.Statistics (librejack)"; } } catch(err) { @@ -106,7 +106,8 @@ <tr class="altColor"> <td class="colFirst"><code>static <a href="../../model/Statistics.html" title="class in model">Statistics</a></code></td> <td class="colLast"><span class="typeNameLabel">Statistics.</span><code><span class="memberNameLink"><a href="../../model/Statistics.html#load--">load</a></span>()</code> -<div class="block">This static method loads the statistics from the CSV file located at the +<div class="block"> + This static method loads the statistics from the CSV file located at the path defined by the CSV_FILE constant in the Statistics class.</div> </td> </tr> diff --git a/docs/model/package-frame.html b/docs/model/package-frame.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>model</title> +<title>model (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> diff --git a/docs/model/package-summary.html b/docs/model/package-summary.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>model</title> +<title>model (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="model"; + parent.document.title="model (librejack)"; } } catch(err) { @@ -86,38 +86,41 @@ <tr class="altColor"> <td class="colFirst"><a href="../model/Card.html" title="class in model">Card</a></td> <td class="colLast"> -<div class="block">Represents a card and handles card operations.</div> +<div class="block">Represents a standard playing card and handles card operations.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../model/Dealer.html" title="class in model">Dealer</a></td> <td class="colLast"> -<div class="block">Handles dealer specific operations, such as drawing cards to 16 and standing - on 17 or above.</div> +<div class="block">Represents a dealer in a card game and handles dealer-specific operations.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../model/Deck.html" title="class in model">Deck</a></td> <td class="colLast"> -<div class="block">Holds multiple cards and performs operations such as shuffling the deck.</div> +<div class="block"> + Holds multiple cards and performs operations such as shuffling the deck.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../model/Person.html" title="class in model">Person</a></td> <td class="colLast"> -<div class="block">Parent class of the Player and Dealer Objects.</div> +<div class="block"> + Parent class of the Player and Dealer Objects.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../model/Player.html" title="class in model">Player</a></td> <td class="colLast"> -<div class="block">Represents a player in a Blackjack game.</div> +<div class="block"> + Represents a player in a blackjack game.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../model/Statistics.html" title="class in model">Statistics</a></td> <td class="colLast"> -<div class="block">The Statistics class represents a set of statistics for a blackjack game.</div> +<div class="block"> + The Statistics class represents a set of statistics for a blackjack game.</div> </td> </tr> </tbody> @@ -133,11 +136,15 @@ <tbody> <tr class="altColor"> <td class="colFirst"><a href="../model/Card.Rank.html" title="enum in model">Card.Rank</a></td> -<td class="colLast">&nbsp;</td> +<td class="colLast"> +<div class="block">Represents the thirteen possible ranks in a standard playing card deck.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../model/Card.Suit.html" title="enum in model">Card.Suit</a></td> -<td class="colLast">&nbsp;</td> +<td class="colLast"> +<div class="block">Represents the four possible suits in a standard playing card deck.</div> +</td> </tr> </tbody> </table> diff --git a/docs/model/package-tree.html b/docs/model/package-tree.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>model Class Hierarchy</title> +<title>model Class Hierarchy (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="model Class Hierarchy"; + parent.document.title="model Class Hierarchy (librejack)"; } } catch(err) { diff --git a/docs/model/package-use.html b/docs/model/package-use.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Package model</title> +<title>Uses of Package model (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package model"; + parent.document.title="Uses of Package model (librejack)"; } } catch(err) { @@ -105,12 +105,13 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../model/class-use/Card.html#controller">Card</a> -<div class="block">Represents a card and handles card operations.</div> +<div class="block">Represents a standard playing card and handles card operations.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><a href="../model/class-use/Deck.html#controller">Deck</a> -<div class="block">Holds multiple cards and performs operations such as shuffling the deck.</div> +<div class="block"> + Holds multiple cards and performs operations such as shuffling the deck.</div> </td> </tr> </tbody> @@ -127,28 +128,35 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../model/class-use/Card.html#model">Card</a> -<div class="block">Represents a card and handles card operations.</div> +<div class="block">Represents a standard playing card and handles card operations.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><a href="../model/class-use/Card.Rank.html#model">Card.Rank</a>&nbsp;</td> +<td class="colOne"><a href="../model/class-use/Card.Rank.html#model">Card.Rank</a> +<div class="block">Represents the thirteen possible ranks in a standard playing card deck.</div> +</td> </tr> <tr class="altColor"> -<td class="colOne"><a href="../model/class-use/Card.Suit.html#model">Card.Suit</a>&nbsp;</td> +<td class="colOne"><a href="../model/class-use/Card.Suit.html#model">Card.Suit</a> +<div class="block">Represents the four possible suits in a standard playing card deck.</div> +</td> </tr> <tr class="rowColor"> <td class="colOne"><a href="../model/class-use/Deck.html#model">Deck</a> -<div class="block">Holds multiple cards and performs operations such as shuffling the deck.</div> +<div class="block"> + Holds multiple cards and performs operations such as shuffling the deck.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><a href="../model/class-use/Person.html#model">Person</a> -<div class="block">Parent class of the Player and Dealer Objects.</div> +<div class="block"> + Parent class of the Player and Dealer Objects.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><a href="../model/class-use/Statistics.html#model">Statistics</a> -<div class="block">The Statistics class represents a set of statistics for a blackjack game.</div> +<div class="block"> + The Statistics class represents a set of statistics for a blackjack game.</div> </td> </tr> </tbody> diff --git a/docs/overview-frame.html b/docs/overview-frame.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Overview List</title> +<title>Overview List (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> diff --git a/docs/overview-summary.html b/docs/overview-summary.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Overview</title> +<title>Overview (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Overview"; + parent.document.title="Overview (librejack)"; } } catch(err) { diff --git a/docs/overview-tree.html b/docs/overview-tree.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Class Hierarchy</title> +<title>Class Hierarchy (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Class Hierarchy"; + parent.document.title="Class Hierarchy (librejack)"; } } catch(err) { diff --git a/docs/serialized-form.html b/docs/serialized-form.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Serialized Form</title> +<title>Serialized Form (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Serialized Form"; + parent.document.title="Serialized Form (librejack)"; } } catch(err) { diff --git a/docs/view/LoginGUI.html b/docs/view/LoginGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:37 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>LoginGUI</title> +<title>LoginGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="LoginGUI"; + parent.document.title="LoginGUI (librejack)"; } } catch(err) { @@ -143,6 +143,9 @@ var activeTableTab = "activeTableTab"; extends javax.swing.JFrame</pre> <div class="block">GUI for login screen.</div> <dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../serialized-form.html#view.LoginGUI">Serialized Form</a></dd> </dl> diff --git a/docs/view/MainGUI.html b/docs/view/MainGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:37 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>MainGUI</title> +<title>MainGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MainGUI"; + parent.document.title="MainGUI (librejack)"; } } catch(err) { @@ -143,6 +143,9 @@ var activeTableTab = "activeTableTab"; extends javax.swing.JFrame</pre> <div class="block">Main GUI.</div> <dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../serialized-form.html#view.MainGUI">Serialized Form</a></dd> </dl> diff --git a/docs/view/StatisticsGUI.html b/docs/view/StatisticsGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>StatisticsGUI</title> +<title>StatisticsGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StatisticsGUI"; + parent.document.title="StatisticsGUI (librejack)"; } } catch(err) { @@ -143,6 +143,9 @@ var activeTableTab = "activeTableTab"; extends javax.swing.JFrame</pre> <div class="block">GUI that displays the player's wins, losses and pushes.</div> <dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Neuper + <a href="mailto:michael@michaelneuper.com">michael@michaelneuper.com</a></dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../serialized-form.html#view.StatisticsGUI">Serialized Form</a></dd> </dl> diff --git a/docs/view/class-use/LoginGUI.html b/docs/view/class-use/LoginGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class view.LoginGUI</title> +<title>Uses of Class view.LoginGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class view.LoginGUI"; + parent.document.title="Uses of Class view.LoginGUI (librejack)"; } } catch(err) { diff --git a/docs/view/class-use/MainGUI.html b/docs/view/class-use/MainGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class view.MainGUI</title> +<title>Uses of Class view.MainGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class view.MainGUI"; + parent.document.title="Uses of Class view.MainGUI (librejack)"; } } catch(err) { diff --git a/docs/view/class-use/StatisticsGUI.html b/docs/view/class-use/StatisticsGUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Class view.StatisticsGUI</title> +<title>Uses of Class view.StatisticsGUI (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class view.StatisticsGUI"; + parent.document.title="Uses of Class view.StatisticsGUI (librejack)"; } } catch(err) { diff --git a/docs/view/package-frame.html b/docs/view/package-frame.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>view</title> +<title>view (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> diff --git a/docs/view/package-summary.html b/docs/view/package-summary.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>view</title> +<title>view (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="view"; + parent.document.title="view (librejack)"; } } catch(err) { diff --git a/docs/view/package-tree.html b/docs/view/package-tree.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>view Class Hierarchy</title> +<title>view Class Hierarchy (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="view Class Hierarchy"; + parent.document.title="view Class Hierarchy (librejack)"; } } catch(err) { diff --git a/docs/view/package-use.html b/docs/view/package-use.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 09:35:39 SAST 2023 --> +<!-- Generated by javadoc (1.8.0_372) on Fri Apr 28 14:00:38 SAST 2023 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Uses of Package view</title> +<title>Uses of Package view (librejack)</title> <meta name="date" content="2023-04-28"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package view"; + parent.document.title="Uses of Package view (librejack)"; } } catch(err) {