push javadoc changes

Burchard36 · Apr 26, 2022 · aa3430e · aa3430e
1 parent ab97c7b
commit aa3430e
Show file tree

Hide file tree

Showing 138 changed files with 715 additions and 461 deletions.
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (16) on Mon Apr 25 20:56:42 PDT 2022 -->
+<!-- Generated by javadoc (16) on Mon Apr 25 21:38:03 PDT 2022 -->
 <title>All Packages (BurchAPI 2.1.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -59,9 +59,13 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="table-header col-first">Package</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/package-summary.html">com.burchard36.api</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Main package for the plugin, holds the 3 main classes, as well as all the other packages</div>
+</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/command/package-summary.html">com.burchard36.api.command</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">The Command API package for this library</div>
+</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/command/actions/package-summary.html">com.burchard36.api.command.actions</a></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/command/annotation/package-summary.html">com.burchard36.api.command.annotation</a></div>
@@ -71,21 +75,27 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/command/interfaces/package-summary.html">com.burchard36.api.command.interfaces</a></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/inventory/package-summary.html">com.burchard36.api.inventory</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">The Inventory API for this library</div>
+</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/inventory/actions/package-summary.html">com.burchard36.api.inventory.actions</a></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/inventory/interfaces/package-summary.html">com.burchard36.api.inventory.interfaces</a></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/json/package-summary.html">com.burchard36.api.json</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">The JSON data library (Currently undergoing a refactor)</div>
+</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/json/annotations/package-summary.html">com.burchard36.api.json.annotations</a></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/json/enums/package-summary.html">com.burchard36.api.json.enums</a></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><a href="com/burchard36/api/json/exceptions/package-summary.html">com.burchard36.api.json.exceptions</a></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><a href="com/burchard36/api/utils/package-summary.html">com.burchard36.api.utils</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Various utilities that may help you in plugin development</div>
+</div>
 </div>
 </main>
 <footer role="contentinfo">

diff --git a/docs/com/burchard36/api/ApiSettings.html b/docs/com/burchard36/api/ApiSettings.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (16) on Mon Apr 25 20:56:42 PDT 2022 -->
+<!-- Generated by javadoc (16) on Mon Apr 25 21:38:03 PDT 2022 -->
 <title>ApiSettings (BurchAPI 2.1.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -82,7 +82,15 @@ <h1 title="Class ApiSettings" class="title">Class ApiSettings</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ApiSettings</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
-<div class="block">The settings for the API to use</div>
+<div class="block">The settings for the API to use.
+
+ do not initialize this, <a href="BurchAPI.html" title="class in com.burchard36.api"><code>BurchAPI</code></a> does this already if your main class extends it.</div>
+<dl class="notes">
+<dt>Since:</dt>
+<dd>2.1.5</dd>
+<dt>Author:</dt>
+<dd>Dalton Burchard</dd>
+</dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -157,6 +165,10 @@ <h3>ApiSettings</h3>
 <div class="block">Creates a new instance of this class
 
  You should not be initializing this, the API does this already</div>
+<dl class="notes">
+<dt>Since:</dt>
+<dd>2.1.5</dd>
+</dl>
 </section>
 </li>
 </ul>
@@ -177,6 +189,8 @@ <h3>blockCommandFromLoading</h3>
 <dd><code>clazz</code> - Class file instance of your class extending <a href="command/ApiCommand.html" title="class in com.burchard36.api.command"><code>ApiCommand</code></a></dd>
 <dt>Returns:</dt>
 <dd>Instance of this <a href="ApiSettings.html" title="class in com.burchard36.api"><code>ApiSettings</code></a></dd>
+<dt>Since:</dt>
+<dd>2.1.5</dd>
 </dl>
 </section>
 </li>
@@ -192,6 +206,8 @@ <h3>useCommandModule</h3>
 <dd><code>useCommandModule</code> - A <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a>, false if you do not want commands to automtically register</dd>
 <dt>Returns:</dt>
 <dd>Instance of this <a href="ApiSettings.html" title="class in com.burchard36.api"><code>ApiSettings</code></a></dd>
+<dt>Since:</dt>
+<dd>2.1.5</dd>
 </dl>
 </section>
 </li>
@@ -207,6 +223,8 @@ <h3>useInventoryModule</h3>
 <dd><code>useInventoryModule</code> - A <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a>, false if the Listener should not be enabled</dd>
 <dt>Returns:</dt>
 <dd>Instance of this <a href="ApiSettings.html" title="class in com.burchard36.api"><code>ApiSettings</code></a></dd>
+<dt>Since:</dt>
+<dd>2.1.5</dd>
 </dl>
 </section>
 </li>