updated generated javadoc for 1.1

pkelaita · Sep 6, 2017 · 8a761db · 8a761db
1 parent 583d2a9
commit 8a761db
Show file tree

Hide file tree

Showing 42 changed files with 162 additions and 131 deletions.
diff --git a/documentation/allclasses-frame.html b/documentation/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>All Classes</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/documentation/allclasses-noframe.html b/documentation/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>All Classes</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/Command.html b/documentation/com/jModule/def/Command.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:01 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Command</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
@@ -113,10 +113,10 @@ <h2 title="Class Command" class="title">Class Command</h2>
 extends java.lang.Object</pre>
 <div class="block">Represents a possible command. A command can have multiple references, or
  ways to call it from the command line. For example, a "find" command that can
- be accessed by typing 'find' or just 'fd' on the command line. A command can
- also have any number of defined parameters and command-specific logic to
- process the given parameters.
-
+ be accessed by typing 'find' or just 'fd' on the command line would have 'fd'
+ as an alternate reference. A command can also have any number of defined
+ parameters and command-specific logic to process the given parameters.
+ <P>
  A command's logic and possible parameters are defined by writing a logic
  class extending CommandLogic. For more information about CommandLogic,
  consult the CommandLogic documentation</div>

diff --git a/documentation/com/jModule/def/CommandLogic.html b/documentation/com/jModule/def/CommandLogic.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:01 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>CommandLogic</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/class-use/Command.html b/documentation/com/jModule/def/class-use/Command.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Class com.jModule.def.Command</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/class-use/CommandLogic.html b/documentation/com/jModule/def/class-use/CommandLogic.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Class com.jModule.def.CommandLogic</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/package-frame.html b/documentation/com/jModule/def/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.def</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/package-summary.html b/documentation/com/jModule/def/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.def</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/package-tree.html b/documentation/com/jModule/def/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.def Class Hierarchy</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/def/package-use.html b/documentation/com/jModule/def/package-use.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Package com.jModule.def</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/ConsoleClient.html b/documentation/com/jModule/exec/ConsoleClient.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>ConsoleClient</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
@@ -18,8 +18,8 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":42};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
@@ -119,7 +119,7 @@ <h2 title="Class ConsoleClient" class="title">Class ConsoleClient</h2>
  windows terminals.</div>
 <dl>
 <dt><span class="simpleTagLabel">Version:</span></dt>
-<dd>1.0.3</dd>
+<dd>1.1.0</dd>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Pierce Kelaita</dd>
 </dl>
@@ -156,18 +156,22 @@ <h3>Constructor Summary</h3>
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/jModule/exec/ConsoleClient.html#addModule-com.jModule.exec.Module-">addModule</a></span>(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/jModule/exec/ConsoleClient.html#addModule-com.jModule.exec.Module-">addModule</a></span>(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>
+<div class="block">Adds a possible module to the client.</div>
+</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/jModule/exec/ConsoleClient.html#removeModule-com.jModule.exec.Module-">removeModule</a></span>(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/jModule/exec/ConsoleClient.html#removeModule-com.jModule.exec.Module-">removeModule</a></span>(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>
+<div class="block">Removes a possible module from the client.</div>
+</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
@@ -179,7 +183,7 @@ <h3>Method Summary</h3>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/jModule/exec/ConsoleClient.html#setHistoryLoggingEnabled-boolean-">setHistoryLoggingEnabled</a></span>(boolean&nbsp;enable)</code>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;&nbsp;</div>
+<div class="block">Sets whether the client will log history of user commands.</div>
 </td>
 </tr>
 </table>
@@ -236,10 +240,8 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>setHistoryLoggingEnabled</h4>
 <pre>public&nbsp;void&nbsp;setHistoryLoggingEnabled(boolean&nbsp;enable)</pre>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
-<div class="block">Sets whether the client will log history of user commands. Deprecated because
- it is not fully ready to be implemented yet, since there is no way to access
- the history yet</div>
+<div class="block">Sets whether the client will log history of user commands. This value is set
+ to false by default.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>enable</code> - if true, client will log command history</dd>
@@ -253,6 +255,12 @@ <h4>setHistoryLoggingEnabled</h4>
 <li class="blockList">
 <h4>addModule</h4>
 <pre>public&nbsp;void&nbsp;addModule(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</pre>
+<div class="block">Adds a possible module to the client. The user can switch to this module by
+ typing its name in the CLI</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>m</code> - Module to add</dd>
+</dl>
 </li>
 </ul>
 <a name="removeModule-com.jModule.exec.Module-">
@@ -262,6 +270,11 @@ <h4>addModule</h4>
 <li class="blockList">
 <h4>removeModule</h4>
 <pre>public&nbsp;void&nbsp;removeModule(<a href="../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</pre>
+<div class="block">Removes a possible module from the client.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>m</code> - Module to remove</dd>
+</dl>
 </li>
 </ul>
 <a name="runConsole--">

diff --git a/documentation/com/jModule/exec/Module.html b/documentation/com/jModule/exec/Module.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Module</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/class-use/ConsoleClient.html b/documentation/com/jModule/exec/class-use/ConsoleClient.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Class com.jModule.exec.ConsoleClient</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/class-use/Module.html b/documentation/com/jModule/exec/class-use/Module.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Class com.jModule.exec.Module</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
@@ -104,11 +104,15 @@ <h3>Uses of <a href="../../../../com/jModule/exec/Module.html" title="class in c
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">ConsoleClient.</span><code><span class="memberNameLink"><a href="../../../../com/jModule/exec/ConsoleClient.html#addModule-com.jModule.exec.Module-">addModule</a></span>(<a href="../../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>&nbsp;</td>
+<td class="colLast"><span class="typeNameLabel">ConsoleClient.</span><code><span class="memberNameLink"><a href="../../../../com/jModule/exec/ConsoleClient.html#addModule-com.jModule.exec.Module-">addModule</a></span>(<a href="../../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>
+<div class="block">Adds a possible module to the client.</div>
+</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">ConsoleClient.</span><code><span class="memberNameLink"><a href="../../../../com/jModule/exec/ConsoleClient.html#removeModule-com.jModule.exec.Module-">removeModule</a></span>(<a href="../../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>&nbsp;</td>
+<td class="colLast"><span class="typeNameLabel">ConsoleClient.</span><code><span class="memberNameLink"><a href="../../../../com/jModule/exec/ConsoleClient.html#removeModule-com.jModule.exec.Module-">removeModule</a></span>(<a href="../../../../com/jModule/exec/Module.html" title="class in com.jModule.exec">Module</a>&nbsp;m)</code>
+<div class="block">Removes a possible module from the client.</div>
+</td>
 </tr>
 </tbody>
 </table>

diff --git a/documentation/com/jModule/exec/package-frame.html b/documentation/com/jModule/exec/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.exec</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/package-summary.html b/documentation/com/jModule/exec/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.exec</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/package-tree.html b/documentation/com/jModule/exec/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>com.jModule.exec Class Hierarchy</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/exec/package-use.html b/documentation/com/jModule/exec/package-use.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:02 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>Uses of Package com.jModule.exec</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/documentation/com/jModule/util/ConsoleUtil.html b/documentation/com/jModule/util/ConsoleUtil.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_144) on Tue Sep 05 14:33:01 PDT 2017 -->
+<!-- Generated by javadoc (1.8.0_144) on Wed Sep 06 12:15:56 PDT 2017 -->
 <title>ConsoleUtil</title>
-<meta name="date" content="2017-09-05">
+<meta name="date" content="2017-09-06">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>