Skip to content

Commit

Permalink
updated javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam-Belliveau committed Jan 22, 2020
1 parent 4033a62 commit 961ff0b
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 9 deletions.
5 changes: 4 additions & 1 deletion docs/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,10 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<tr id="i38" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/streams/filters/RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters">RateLimit</a></td>
<th class="colLast" scope="row">
<div class="block">This class lets you rate limit a stream of inputs</div>
<div class="block">This class lets you rate limit a stream of inputs

That means that the value can not change more than a specified amount in one
update</div>
</th>
</tr>
<tr id="i39" class="rowColor">
Expand Down
1 change: 0 additions & 1 deletion docs/com/stuypulse/stuylib/file/csv/CSVWriter.html
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,6 @@ <h4>CSVWriter</h4>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - file name</dd>
<dd><code>type</code> - type of csv file</dd>
<dd><code>append</code> - if the csv file should be added onto or rewritten</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - error with opening file</dd>
</dl>
Expand Down
35 changes: 33 additions & 2 deletions docs/com/stuypulse/stuylib/streams/filters/RateLimit.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,10 @@ <h2 title="Class RateLimit" class="title">Class RateLimit</h2>
<hr>
<pre>public class <span class="typeNameLabel">RateLimit</span>
extends <a href="OnDerivative.html" title="class in com.stuypulse.stuylib.streams.filters">OnDerivative</a></pre>
<div class="block">This class lets you rate limit a stream of inputs</div>
<div class="block">This class lets you rate limit a stream of inputs

That means that the value can not change more than a specified amount in one
update</div>
</li>
</ul>
</div>
Expand All @@ -162,6 +165,14 @@ <h3>Constructor Summary</h3>
<div class="block">Makes a new rate limiter with specified rate limit</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(double,double)">RateLimit</a></span>&#8203;(double&nbsp;accelLimit,
double&nbsp;decelLimit)</code></th>
<td class="colLast">
<div class="block">Makes a new rate limiter with specified rate limit for accelerating and
decelerating.</div>
</td>
</tr>
</table>
</li>
</ul>
Expand Down Expand Up @@ -206,7 +217,7 @@ <h3>Constructor Detail</h3>
<a id="&lt;init&gt;(double)">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>RateLimit</h4>
<pre>public&nbsp;RateLimit&#8203;(double&nbsp;rateLimit)
Expand All @@ -220,6 +231,26 @@ <h4>RateLimit</h4>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(double,double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RateLimit</h4>
<pre>public&nbsp;RateLimit&#8203;(double&nbsp;accelLimit,
double&nbsp;decelLimit)
throws <a href="../../exception/ConstructionError.html" title="class in com.stuypulse.stuylib.exception">ConstructionError</a></pre>
<div class="block">Makes a new rate limiter with specified rate limit for accelerating and
decelerating. This allows for more control over how the moves</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accelLimit</code> - desired rate limit when accelerating</dd>
<dd><code>decelLimit</code> - desired rate limit when decelerating</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../exception/ConstructionError.html" title="class in com.stuypulse.stuylib.exception">ConstructionError</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ <h4>RollingAverage</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accel_weight</code> - weight when accelerating</dd>
<dd><code>accel_weight</code> - weight when decelerating</dd>
<dd><code>decel_weight</code> - weight when decelerating</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../exception/ConstructionError.html" title="class in com.stuypulse.stuylib.exception">ConstructionError</a></code></dd>
</dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,10 @@ <h1 title="Package" class="title">Package&nbsp;com.stuypulse.stuylib.streams.fil
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters">RateLimit</a></th>
<td class="colLast">
<div class="block">This class lets you rate limit a stream of inputs</div>
<div class="block">This class lets you rate limit a stream of inputs

That means that the value can not change more than a specified amount in one
update</div>
</td>
</tr>
<tr class="rowColor">
Expand Down
10 changes: 9 additions & 1 deletion docs/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -1256,12 +1256,20 @@ <h2 class="title">R</h2>
<dl>
<dt><a href="com/stuypulse/stuylib/streams/filters/RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters"><span class="typeNameLink">RateLimit</span></a> - Class in <a href="com/stuypulse/stuylib/streams/filters/package-summary.html">com.stuypulse.stuylib.streams.filters</a></dt>
<dd>
<div class="block">This class lets you rate limit a stream of inputs</div>
<div class="block">This class lets you rate limit a stream of inputs

That means that the value can not change more than a specified amount in one
update</div>
</dd>
<dt><span class="memberNameLink"><a href="com/stuypulse/stuylib/streams/filters/RateLimit.html#%3Cinit%3E(double)">RateLimit(double)</a></span> - Constructor for class com.stuypulse.stuylib.streams.filters.<a href="com/stuypulse/stuylib/streams/filters/RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters">RateLimit</a></dt>
<dd>
<div class="block">Makes a new rate limiter with specified rate limit</div>
</dd>
<dt><span class="memberNameLink"><a href="com/stuypulse/stuylib/streams/filters/RateLimit.html#%3Cinit%3E(double,double)">RateLimit(double, double)</a></span> - Constructor for class com.stuypulse.stuylib.streams.filters.<a href="com/stuypulse/stuylib/streams/filters/RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters">RateLimit</a></dt>
<dd>
<div class="block">Makes a new rate limiter with specified rate limit for accelerating and
decelerating.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/stuypulse/stuylib/file/csv/CSVReader.html#read()">read()</a></span> - Method in class com.stuypulse.stuylib.file.csv.<a href="com/stuypulse/stuylib/file/csv/CSVReader.html" title="class in com.stuypulse.stuylib.file.csv">CSVReader</a></dt>
<dd>
<div class="block">Read data from opened file.</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/member-search-index.js

Large diffs are not rendered by default.

Binary file modified docs/member-search-index.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/overview-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Wed Jan 22 14:18:14 EST 2020 -->
<!-- Generated by javadoc (11.0.5) on Wed Jan 22 14:23:17 EST 2020 -->
<title>StuyLib API</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<script type="text/javascript">window.location.replace('index.html')</script>
Expand Down
Binary file modified docs/package-search-index.zip
Binary file not shown.
Binary file modified docs/type-search-index.zip
Binary file not shown.

0 comments on commit 961ff0b

Please sign in to comment.