Improve docs.

jmp · Mar 18, 2018 · fae5b6b · fae5b6b
1 parent f2130f0
commit fae5b6b
Show file tree

Hide file tree

Showing 15 changed files with 157 additions and 47 deletions.
diff --git a/docs/Card.html b/docs/Card.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Card</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -18,7 +18,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10};
+var methods = {"i0":9,"i1":10,"i2":10,"i3":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -211,7 +211,9 @@ <h3>Constructor Summary</h3>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="Card.html#Card-int-int-">Card</a></span>(int&nbsp;rank,
-    int&nbsp;suit)</code>&nbsp;</td>
+    int&nbsp;suit)</code>
+<div class="block">Creates a new card with the given rank and suit.</div>
+</td>
 </tr>
 </table>
 </li>
@@ -230,23 +232,27 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#fromString-java.lang.String-">fromString</a></span>(java.lang.String&nbsp;string)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#fromString-java.lang.String-">fromString</a></span>(java.lang.String&nbsp;string)</code>
+<div class="block">Create a new <a href="Card.html" title="class in &lt;Unnamed&gt;"><code>Card</code></a> instance from the given string.</div>
+</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#getRank--">getRank</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#getRank--">getRank</a></span>()</code>
+<div class="block">Returns the rank 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="Card.html#getSuit--">getSuit</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#getSuit--">getSuit</a></span>()</code>
+<div class="block">Returns the suit of the card.</div>
+</td>
 </tr>
 <tr id="i3" class="rowColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#getValue--">getValue</a></span>()</code>&nbsp;</td>
-</tr>
-<tr id="i4" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#toString--">toString</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="Card.html#toString--">toString</a></span>()</code>
+<div class="block">Returns a string representation of the card.</div>
+</td>
 </tr>
 </table>
 <ul class="blockList">
@@ -507,6 +513,12 @@ <h3>Constructor Detail</h3>
 <h4>Card</h4>
 <pre>public&nbsp;Card(int&nbsp;rank,
             int&nbsp;suit)</pre>
+<div class="block">Creates a new card with the given rank and suit.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>rank</code> - the rank of the card, e.g. <a href="Card.html#SIX"><code>SIX</code></a></dd>
+<dd><code>suit</code> - the suit of the card, e.g. <a href="Card.html#CLUBS"><code>CLUBS</code></a></dd>
+</dl>
 </li>
 </ul>
 </li>
@@ -524,6 +536,16 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>fromString</h4>
 <pre>public static&nbsp;<a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a>&nbsp;fromString(java.lang.String&nbsp;string)</pre>
+<div class="block">Create a new <a href="Card.html" title="class in &lt;Unnamed&gt;"><code>Card</code></a> instance from the given string.
+ The string should be a two-character string where the first character
+ is the rank and the second character is the suit. For example, "Kc" means
+ the king of clubs, and "As" means the ace of spades.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>string</code> - Card to create as a string.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a new <a href="Card.html" title="class in &lt;Unnamed&gt;"><code>Card</code></a> instance corresponding to the given string.</dd>
+</dl>
 </li>
 </ul>
 <a name="getRank--">
@@ -533,6 +555,25 @@ <h4>fromString</h4>
 <li class="blockList">
 <h4>getRank</h4>
 <pre>public&nbsp;int&nbsp;getRank()</pre>
+<div class="block">Returns the rank of the card.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>rank of the card as an integer.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Card.html#ACE"><code>ACE</code></a>, 
+<a href="Card.html#DEUCE"><code>DEUCE</code></a>, 
+<a href="Card.html#TREY"><code>TREY</code></a>, 
+<a href="Card.html#FOUR"><code>FOUR</code></a>, 
+<a href="Card.html#FIVE"><code>FIVE</code></a>, 
+<a href="Card.html#SIX"><code>SIX</code></a>, 
+<a href="Card.html#SEVEN"><code>SEVEN</code></a>, 
+<a href="Card.html#EIGHT"><code>EIGHT</code></a>, 
+<a href="Card.html#NINE"><code>NINE</code></a>, 
+<a href="Card.html#TEN"><code>TEN</code></a>, 
+<a href="Card.html#JACK"><code>JACK</code></a>, 
+<a href="Card.html#QUEEN"><code>QUEEN</code></a>, 
+<a href="Card.html#KING"><code>KING</code></a></dd>
+</dl>
 </li>
 </ul>
 <a name="getSuit--">
@@ -542,15 +583,16 @@ <h4>getRank</h4>
 <li class="blockList">
 <h4>getSuit</h4>
 <pre>public&nbsp;int&nbsp;getSuit()</pre>
-</li>
-</ul>
-<a name="getValue--">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getValue</h4>
-<pre>public&nbsp;int&nbsp;getValue()</pre>
+<div class="block">Returns the suit of the card.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Suit of the card as an integer.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Card.html#SPADES"><code>SPADES</code></a>, 
+<a href="Card.html#HEARTS"><code>HEARTS</code></a>, 
+<a href="Card.html#DIAMONDS"><code>DIAMONDS</code></a>, 
+<a href="Card.html#CLUBS"><code>CLUBS</code></a></dd>
+</dl>
 </li>
 </ul>
 <a name="toString--">
@@ -560,9 +602,13 @@ <h4>getValue</h4>
 <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.
+ For example, the king of spades is "Ks", and the jack of hearts is "Jh".</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.</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/Hand.html b/docs/Hand.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Hand</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -130,7 +130,7 @@ <h3>Method Summary</h3>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="Hand.html#evaluate-Card:A-">evaluate</a></span>(<a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a>[]&nbsp;cards)</code>
-<div class="block">Poker hand evaluator based on Kevin Suffecool's 5-card hand evaluator and with Paul Senzee's pre-computed hash.</div>
+<div class="block">Evaluates the given hand and returns its value as an integer.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
@@ -174,7 +174,8 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>evaluate</h4>
 <pre>public static&nbsp;int&nbsp;evaluate(<a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a>[]&nbsp;cards)</pre>
-<div class="block">Poker hand evaluator based on Kevin Suffecool's 5-card hand evaluator and with Paul Senzee's pre-computed hash.</div>
+<div class="block">Evaluates the given hand and returns its value as an integer.
+ Based on Kevin Suffecool's 5-card hand evaluator and with Paul Senzee's pre-computed hash.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cards</code> - a hand of cards to evaluate</dd>
@@ -196,6 +197,8 @@ <h4>fromString</h4>
 <dd><code>string</code> - the string to create the hand from, such as "Kd 5s Jc Ah Qc"</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a new hand as an array of cards</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="Card.html" title="class in &lt;Unnamed&gt;"><code>Card</code></a></dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>All Classes</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>All Classes</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Constant Field Values</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Deprecated List</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:07 EET 2018 -->
 <title>API Help</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/index-all.html b/docs/index-all.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Index</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -85,7 +85,9 @@ <h2 class="title">C</h2>
 <div class="block">An immutable class representing a card from a normal 52-card deck.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="Card.html#Card-int-int-">Card(int, int)</a></span> - Constructor for class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Creates a new card with the given rank and suit.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="Card.html#CLUBS">CLUBS</a></span> - Static variable in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
 <dd>&nbsp;</dd>
 </dl>
@@ -108,7 +110,7 @@ <h2 class="title">E</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="Hand.html#evaluate-Card:A-">evaluate(Card[])</a></span> - Static method in class <a href="Hand.html" title="class in &lt;Unnamed&gt;">Hand</a></dt>
 <dd>
-<div class="block">Poker hand evaluator based on Kevin Suffecool's 5-card hand evaluator and with Paul Senzee's pre-computed hash.</div>
+<div class="block">Evaluates the given hand and returns its value as an integer.</div>
 </dd>
 </dl>
 <a name="I:F">
@@ -121,7 +123,9 @@ <h2 class="title">F</h2>
 <dt><span class="memberNameLink"><a href="Card.html#FOUR">FOUR</a></span> - Static variable in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="Card.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Create a new <a href="Card.html" title="class in &lt;Unnamed&gt;"><code>Card</code></a> instance from the given string.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="Hand.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in class <a href="Hand.html" title="class in &lt;Unnamed&gt;">Hand</a></dt>
 <dd>
 <div class="block">Creates a new 5-card hand from the given string.</div>
@@ -133,11 +137,13 @@ <h2 class="title">F</h2>
 <h2 class="title">G</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="Card.html#getRank--">getRank()</a></span> - Method in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Returns the rank of the card.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="Card.html#getSuit--">getSuit()</a></span> - Method in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="Card.html#getValue--">getValue()</a></span> - Method in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Returns the suit of the card.</div>
+</dd>
 </dl>
 <a name="I:H">
 <!--   -->
@@ -203,7 +209,9 @@ <h2 class="title">T</h2>
 <dt><span class="memberNameLink"><a href="Card.html#TEN">TEN</a></span> - Static variable in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="Card.html#toString--">toString()</a></span> - Method in class <a href="Card.html" title="class in &lt;Unnamed&gt;">Card</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Returns a string representation of the card.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="Hand.html#toString-Card:A-">toString(Card[])</a></span> - Static method in class <a href="Hand.html" title="class in &lt;Unnamed&gt;">Hand</a></dt>
 <dd>
 <div class="block">Converts the given hand into concatenation of their string representations</div>

diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Generated Documentation (Untitled)</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;

diff --git a/docs/overview-tree.html b/docs/overview-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>Class Hierarchy</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/package-frame.html b/docs/package-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title>&lt;Unnamed&gt;</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/package-summary.html b/docs/package-summary.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>

diff --git a/docs/package-tree.html b/docs/package-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 13:32:17 EET 2018 -->
+<!-- Generated by javadoc (1.8.0_131) on Sun Mar 18 14:17:06 EET 2018 -->
 <title> Class Hierarchy</title>
 <meta name="date" content="2018-03-18">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">