Skip to content

Commit

Permalink
update JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@RVRX
RVRX committed Jul 21, 2021
1 parent 4753b58 commit 66be689
Show file tree
Hide file tree
Showing 34 changed files with 342 additions and 195 deletions.
2 changes: 1 addition & 1 deletion docs/javadoc/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (GoIStreamToolRedux 1.0.0 API)</title>
<title>All Classes (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
2 changes: 1 addition & 1 deletion docs/javadoc/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (GoIStreamToolRedux 1.0.0 API)</title>
<title>All Classes (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
6 changes: 3 additions & 3 deletions docs/javadoc/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Constant Field Values (GoIStreamToolRedux 1.0.0 API)</title>
<title>Constant Field Values (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (GoIStreamToolRedux 1.0.0 API)";
parent.document.title="Constant Field Values (GoIStreamToolRedux 1.1.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -93,7 +93,7 @@ <h2 title="goistreamtoolredux">goistreamtoolredux.*</h2>
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="goistreamtoolredux/App.html#version">version</a></code></td>
<td class="colLast"><code>"1.0.0"</code></td>
<td class="colLast"><code>"1.1.0"</code></td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/javadoc/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Deprecated List (GoIStreamToolRedux 1.0.0 API)</title>
<title>Deprecated List (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (GoIStreamToolRedux 1.0.0 API)";
parent.document.title="Deprecated List (GoIStreamToolRedux 1.1.0 API)";
}
}
catch(err) {
Expand Down
12 changes: 6 additions & 6 deletions docs/javadoc/goistreamtoolredux/App.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>App (GoIStreamToolRedux 1.0.0 API)</title>
<title>App (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="App (GoIStreamToolRedux 1.0.0 API)";
parent.document.title="App (GoIStreamToolRedux 1.1.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -48,7 +48,7 @@
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="Main.html" title="class in goistreamtoolredux"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../goistreamtoolredux/Main.html" title="class in goistreamtoolredux"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?goistreamtoolredux/App.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -191,7 +191,7 @@ <h3>Method Summary</h3>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="controller/Master.html" title="class in goistreamtoolredux.controller">Master</a></code></td>
<td class="colFirst"><code>static <a href="../goistreamtoolredux/controller/Master.html" title="class in goistreamtoolredux.controller">Master</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../goistreamtoolredux/App.html#getMasterController--">getMasterController</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
Expand Down Expand Up @@ -298,7 +298,7 @@ <h4>getPrimaryStage</h4>
<ul class="blockList">
<li class="blockList">
<h4>getMasterController</h4>
<pre>public static&nbsp;<a href="controller/Master.html" title="class in goistreamtoolredux.controller">Master</a>&nbsp;getMasterController()</pre>
<pre>public static&nbsp;<a href="../goistreamtoolredux/controller/Master.html" title="class in goistreamtoolredux.controller">Master</a>&nbsp;getMasterController()</pre>
</li>
</ul>
<a name="init--">
Expand Down Expand Up @@ -382,7 +382,7 @@ <h4>showExceptionDialog</h4>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="Main.html" title="class in goistreamtoolredux"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../goistreamtoolredux/Main.html" title="class in goistreamtoolredux"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?goistreamtoolredux/App.html" target="_top">Frames</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/javadoc/goistreamtoolredux/Main.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Main (GoIStreamToolRedux 1.0.0 API)</title>
<title>Main (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Main (GoIStreamToolRedux 1.0.0 API)";
parent.document.title="Main (GoIStreamToolRedux 1.1.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -47,7 +47,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="App.html" title="class in goistreamtoolredux"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../goistreamtoolredux/App.html" title="class in goistreamtoolredux"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
Expand Down Expand Up @@ -223,7 +223,7 @@ <h4>main</h4>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="App.html" title="class in goistreamtoolredux"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../goistreamtoolredux/App.html" title="class in goistreamtoolredux"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
Expand Down
85 changes: 66 additions & 19 deletions docs/javadoc/goistreamtoolredux/algorithm/AppTimer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AppTimer (GoIStreamToolRedux 1.0.0 API)</title>
<title>AppTimer (GoIStreamToolRedux 1.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AppTimer (GoIStreamToolRedux 1.0.0 API)";
parent.document.title="AppTimer (GoIStreamToolRedux 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10};
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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";
Expand Down Expand Up @@ -48,7 +48,7 @@
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="FileManager.html" title="class in goistreamtoolredux.algorithm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../goistreamtoolredux/algorithm/FileManager.html" title="class in goistreamtoolredux.algorithm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?goistreamtoolredux/algorithm/AppTimer.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -98,7 +98,7 @@ <h2 title="Class AppTimer" class="title">Class AppTimer</h2>
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="Timers.html" title="class in goistreamtoolredux.algorithm">goistreamtoolredux.algorithm.Timers</a></li>
<li><a href="../../goistreamtoolredux/algorithm/Timers.html" title="class in goistreamtoolredux.algorithm">goistreamtoolredux.algorithm.Timers</a></li>
<li>
<ul class="inheritance">
<li>goistreamtoolredux.algorithm.AppTimer</li>
Expand All @@ -113,7 +113,7 @@ <h2 title="Class AppTimer" class="title">Class AppTimer</h2>
<hr>
<br>
<pre>public class <span class="typeNameLabel">AppTimer</span>
extends <a href="Timers.html" title="class in goistreamtoolredux.algorithm">Timers</a></pre>
extends <a href="../../goistreamtoolredux/algorithm/Timers.html" title="class in goistreamtoolredux.algorithm">Timers</a></pre>
<div class="block">Singleton timer class.
Warning: gets confusing with all the uses of timer as a word, vs the actual JDK Timer class.</div>
</li>
Expand Down Expand Up @@ -158,28 +158,40 @@ <h3>Method Summary</h3>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#getCurrentTimer--">getCurrentTimer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#getCurrentTimerStartLength--">getCurrentTimerStartLength</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../goistreamtoolredux/algorithm/AppTimer.html" title="class in goistreamtoolredux.algorithm">AppTimer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#getStartTime--">getStartTime</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#pause--">pause</a></span>()</code>
<div class="block">Pauses the current timer state.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#restart--">restart</a></span>()</code>
<div class="block">Resets the timer back to beginning value and starts it again</div>
</td>
</tr>
<tr id="i4" class="altColor">
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#setTimeAtPause-long-">setTimeAtPause</a></span>(long&nbsp;timeAtPause)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#start--">start</a></span>()</code>
<div class="block">Start the timer (initial or after a pause)</div>
<div class="block">Starts the timer (initial or after a pause), is one is not already running (i.e., <a href="../../goistreamtoolredux/algorithm/AppTimer.html#isTimerRunning"><code>isTimerRunning</code></a> is false).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../goistreamtoolredux/algorithm/AppTimer.html#stop--">stop</a></span>()</code>
<div class="block">Completely stops and cancels the timer.</div>
Expand All @@ -190,8 +202,8 @@ <h3>Method Summary</h3>
<li class="blockList"><a name="methods.inherited.from.class.goistreamtoolredux.algorithm.Timers">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;goistreamtoolredux.algorithm.<a href="Timers.html" title="class in goistreamtoolredux.algorithm">Timers</a></h3>
<code><a href="Timers.html#convertFromMinuteFormat-java.lang.String-">convertFromMinuteFormat</a>, <a href="Timers.html#convertToMinuteFormat-int-">convertToMinuteFormat</a>, <a href="Timers.html#get--">get</a>, <a href="Timers.html#getInitialTimerLength--">getInitialTimerLength</a>, <a href="Timers.html#set-int-">set</a>, <a href="Timers.html#setInitialTimerLength-int-">setInitialTimerLength</a>, <a href="Timers.html#setInitialTimerTwoLength-int-">setInitialTimerTwoLength</a></code></li>
<h3>Methods inherited from class&nbsp;goistreamtoolredux.algorithm.<a href="../../goistreamtoolredux/algorithm/Timers.html" title="class in goistreamtoolredux.algorithm">Timers</a></h3>
<code><a href="../../goistreamtoolredux/algorithm/Timers.html#convertFromMinuteFormat-java.lang.String-">convertFromMinuteFormat</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#convertToMinuteFormat-int-">convertToMinuteFormat</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#get--">get</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#getInitialTimerLength--">getInitialTimerLength</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#set-int-">set</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#setInitialTimerLength-int-">setInitialTimerLength</a>, <a href="../../goistreamtoolredux/algorithm/Timers.html#setInitialTimerTwoLength-int-">setInitialTimerTwoLength</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
Expand Down Expand Up @@ -240,6 +252,33 @@ <h4>getCurrentTimer</h4>
<pre>public&nbsp;java.util.Timer&nbsp;getCurrentTimer()</pre>
</li>
</ul>
<a name="getStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre>public&nbsp;long&nbsp;getStartTime()</pre>
</li>
</ul>
<a name="getCurrentTimerStartLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTimerStartLength</h4>
<pre>public&nbsp;int&nbsp;getCurrentTimerStartLength()</pre>
</li>
</ul>
<a name="setTimeAtPause-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeAtPause</h4>
<pre>public&nbsp;void&nbsp;setTimeAtPause(long&nbsp;timeAtPause)</pre>
</li>
</ul>
<a name="getInstance--">
<!-- -->
</a>
Expand All @@ -258,13 +297,21 @@ <h4>start</h4>
<pre>public&nbsp;void&nbsp;start()
throws java.io.IOException,
java.util.NoSuchElementException,
<a href="InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></pre>
<div class="block">Start the timer (initial or after a pause)</div>
<a href="../../goistreamtoolredux/algorithm/InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></pre>
<div class="block">Starts the timer (initial or after a pause), is one is not already running (i.e., <a href="../../goistreamtoolredux/algorithm/AppTimer.html#isTimerRunning"><code>isTimerRunning</code></a> is false).
<p>
Sets the value of <a href="../../goistreamtoolredux/algorithm/AppTimer.html#startTime"><code>startTime</code></a> to be either:
<ul>
<li>If resuming from a pause – time at initial start, plus difference between resume and initial pause
<li>If initial start – Current system time.
</ul>

<p>Sets the value of <a href="../../goistreamtoolredux/algorithm/AppTimer.html#isTimerRunning"><code>isTimerRunning</code></a> to true before starting the</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.util.NoSuchElementException</code></dd>
<dd><code><a href="InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></code></dd>
<dd><code><a href="../../goistreamtoolredux/algorithm/InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../goistreamtoolredux/algorithm/AppTimer.html#stop--"><code>stop()</code></a>,
<a href="../../goistreamtoolredux/algorithm/AppTimer.html#pause--"><code>pause()</code></a>,
Expand Down Expand Up @@ -320,12 +367,12 @@ <h4>pause</h4>
<h4>restart</h4>
<pre>public&nbsp;void&nbsp;restart()
throws java.io.IOException,
<a href="InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></pre>
<a href="../../goistreamtoolredux/algorithm/InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></pre>
<div class="block">Resets the timer back to beginning value and starts it again</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code><a href="InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></code></dd>
<dd><code><a href="../../goistreamtoolredux/algorithm/InvalidDataException.html" title="class in goistreamtoolredux.algorithm">InvalidDataException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../goistreamtoolredux/algorithm/AppTimer.html#start--"><code>start()</code></a>,
<a href="../../goistreamtoolredux/algorithm/AppTimer.html#stop--"><code>stop()</code></a>,
Expand Down Expand Up @@ -361,7 +408,7 @@ <h4>restart</h4>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="FileManager.html" title="class in goistreamtoolredux.algorithm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../goistreamtoolredux/algorithm/FileManager.html" title="class in goistreamtoolredux.algorithm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?goistreamtoolredux/algorithm/AppTimer.html" target="_top">Frames</a></li>
Expand Down
Loading

0 comments on commit 66be689

Please sign in to comment.