Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-23 06:41:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated javadocs

Browse Source
This commit is contained in:
thenetworkgrinch
2024-01-16 16:53:58 -06:00
parent bf59167648
commit 09a8312a5c
104 changed files with 217 additions and 231 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/swervelib/encoders/CanAndCoderSwerve.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<title>CanAndCoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="dc.created" content="2024-01-16">
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -98,11 +98,6 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div>
</div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state of the encoder.</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
@@ -143,7 +138,7 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean&nbsp;inverted)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the CANandCoder to read from [0, 360) per second.</div>
<div class="block">Configure the Canandcoder to read from [0, 360) per second.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
@@ -168,7 +163,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Cannot set the offset of the CanAndCoder.</div>
<div class="block">Cannot set the offset of the Canandcoder.</div>
</div>
</div>
</div>
@@ -194,13 +189,6 @@ loadScripts(document, 'script');</script>
<div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div>
</section>
</li>
<li>
<section class="detail" id="inverted">
<h3>inverted</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">inverted</span></div>
<div class="block">Inversion state of the encoder.</div>
</section>
</li>
</ul>
</section>
</li>
@@ -232,7 +220,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="factoryDefault()">
<h3>factoryDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">factoryDefault</span>()</div>
<div class="block">Reset the encoder to factory defaults.</div>
<div class="block">Reset the encoder to factory defaults.
This will not clear the stored zero offset.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code>&nbsp;in class&nbsp;<code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
@@ -254,7 +244,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="configure(boolean)">
<h3>configure</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configure</span><wbr><span class="parameters">(boolean&nbsp;inverted)</span></div>
<div class="block">Configure the CANandCoder to read from [0, 360) per second.</div>
<div class="block">Configure the Canandcoder to read from [0, 360) per second.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code>&nbsp;in class&nbsp;<code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
@@ -293,14 +283,14 @@ loadScripts(document, 'script');</script>
<section class="detail" id="setAbsoluteEncoderOffset(double)">
<h3>setAbsoluteEncoderOffset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double&nbsp;offset)</span></div>
<div class="block">Cannot set the offset of the CanAndCoder.</div>
<div class="block">Cannot set the offset of the Canandcoder.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code>&nbsp;in class&nbsp;<code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
<dt>Returns:</dt>
<dd>always false due to CanAndCoder not supporting offset changing.</dd>
<dd>true if setting the zero point succeeded, false otherwise</dd>
</dl>
</section>
</li>