Merge pull request #65 from CSC207-2023Y-UofT/63-update-generated-jav…

…adoc-documentation Update generated JavaDoc documentation
CSC207-2023Y-UofT · Aug 16, 2023 · a5500d6 · a5500d6
2 parents 26235f6 + b7989e9
commit a5500d6
Show file tree

Hide file tree

Showing 176 changed files with 10,427 additions and 17,914 deletions.
diff --git a/reports/JavaDoc/Main.html b/reports/JavaDoc/Main.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.19) on Sun Aug 06 00:27:18 EDT 2023 -->
+<!-- Generated by javadoc (11.0.19) on Tue Aug 15 20:29:21 EDT 2023 -->
 <title>Main</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-08-06">
+<meta name="dc.created" content="2023-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

diff --git a/reports/JavaDoc/allclasses-index.html b/reports/JavaDoc/allclasses-index.html
diff --git a/reports/JavaDoc/allclasses.html b/reports/JavaDoc/allclasses.html
diff --git a/reports/JavaDoc/allpackages-index.html b/reports/JavaDoc/allpackages-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.19) on Sun Aug 06 00:27:18 EDT 2023 -->
+<!-- Generated by javadoc (11.0.19) on Tue Aug 15 20:29:21 EDT 2023 -->
 <title>All Packages</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-08-06">
+<meta name="dc.created" content="2023-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

diff --git a/reports/JavaDoc/constant-values.html b/reports/JavaDoc/constant-values.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.19) on Sun Aug 06 00:27:18 EDT 2023 -->
+<!-- Generated by javadoc (11.0.19) on Tue Aug 15 20:29:21 EDT 2023 -->
 <title>Constant Field Values</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-08-06">
+<meta name="dc.created" content="2023-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

diff --git a/reports/JavaDoc/deprecated-list.html b/reports/JavaDoc/deprecated-list.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.19) on Sun Aug 06 00:27:18 EDT 2023 -->
+<!-- Generated by javadoc (11.0.19) on Tue Aug 15 20:29:21 EDT 2023 -->
 <title>Deprecated List</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-08-06">
+<meta name="dc.created" content="2023-08-15">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

diff --git a/reports/JavaDoc/entities/Category.html b/reports/JavaDoc/entities/Category.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.19) on Sun Aug 06 00:27:18 EDT 2023 -->
+<!-- Generated by javadoc (11.0.19) on Tue Aug 15 20:29:21 EDT 2023 -->
 <title>Category</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-08-06">
+<meta name="dc.created" content="2023-08-15">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
@@ -90,13 +90,13 @@
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
-<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
-<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
@@ -133,13 +133,14 @@ <h2 title="Class Category" class="title">Class Category</h2>
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
-<dd><code>java.io.Serializable</code></dd>
+<dd><code><a href="MonthObject.html" title="interface in entities">MonthObject</a></code>, <code>java.io.Serializable</code></dd>
 </dl>
 <hr>
 <pre>public class <span class="typeNameLabel">Category</span>
 extends java.lang.Object
-implements java.io.Serializable</pre>
-<div class="block">A class that will store all the data associated with a Category. This includes a name and budget.</div>
+implements <a href="MonthObject.html" title="interface in entities">MonthObject</a>, java.io.Serializable</pre>
+<div class="block">A class that will store all the data associated with a Category. This includes a name and budget.
+ It implements the MonthObject interface, which allows for it to be created using a MonthObjectFactory.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../serialized-form.html#entities.Category">Serialized Form</a></dd>
@@ -150,34 +151,6 @@ <h2 title="Class Category" class="title">Class Category</h2>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
-<!-- =========== FIELD SUMMARY =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.summary">
-<!--   -->
-</a>
-<h3>Field Summary</h3>
-<table class="memberSummary">
-<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colSecond" scope="col">Field</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private double</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#budget">budget</a></span></code></th>
-<td class="colLast">&nbsp;</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private java.lang.String</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name">name</a></span></code></th>
-<td class="colLast">&nbsp;</td>
-</tr>
-</table>
-</li>
-</ul>
-</section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section>
 <ul class="blockList">
@@ -239,14 +212,14 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBudget(double)">setBudget</a></span>&#8203;(double&nbsp;new_budget)</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBudget(double)">setBudget</a></span>&#8203;(double&nbsp;newBudget)</code></th>
 <td class="colLast">
 <div class="block">Sets the budget of this Category.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setName(java.lang.String)">setName</a></span>&#8203;(java.lang.String&nbsp;new_name)</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setName(java.lang.String)">setName</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
 <td class="colLast">
 <div class="block">Sets the name of this Category.</div>
 </td>
@@ -268,34 +241,6 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
-<!-- ============ FIELD DETAIL =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.detail">
-<!--   -->
-</a>
-<h3>Field Detail</h3>
-<a id="name">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>name</h4>
-<pre>private&nbsp;java.lang.String name</pre>
-</li>
-</ul>
-<a id="budget">
-<!--   -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>budget</h4>
-<pre>private&nbsp;double budget</pre>
-</li>
-</ul>
-</li>
-</ul>
-</section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section>
 <ul class="blockList">
@@ -335,11 +280,13 @@ <h3>Method Detail</h3>
 <ul class="blockList">
 <li class="blockList">
 <h4>setName</h4>
-<pre class="methodSignature">public&nbsp;void&nbsp;setName&#8203;(java.lang.String&nbsp;new_name)</pre>
+<pre class="methodSignature">public&nbsp;void&nbsp;setName&#8203;(java.lang.String&nbsp;name)</pre>
 <div class="block">Sets the name of this Category.</div>
 <dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="MonthObject.html#setName(java.lang.String)">setName</a></code>&nbsp;in interface&nbsp;<code><a href="MonthObject.html" title="interface in entities">MonthObject</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>new_name</code> - the new name that this Category will have</dd>
+<dd><code>name</code> - the new name that this Category will have</dd>
 </dl>
 </li>
 </ul>
@@ -349,11 +296,11 @@ <h4>setName</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>setBudget</h4>
-<pre class="methodSignature">public&nbsp;void&nbsp;setBudget&#8203;(double&nbsp;new_budget)</pre>
+<pre class="methodSignature">public&nbsp;void&nbsp;setBudget&#8203;(double&nbsp;newBudget)</pre>
 <div class="block">Sets the budget of this Category.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>new_budget</code> - the new budget that this Category will have</dd>
+<dd><code>newBudget</code> - the new budget that this Category will have</dd>
 </dl>
 </li>
 </ul>
@@ -366,6 +313,8 @@ <h4>getName</h4>
 <pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
 <div class="block">Gets the name of this Category.</div>
 <dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="MonthObject.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="MonthObject.html" title="interface in entities">MonthObject</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the name of this Category</dd>
 </dl>
@@ -455,13 +404,13 @@ <h4>equals</h4>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
-<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
-<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>