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

Updated documentation, renamed functions to make more sense.

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-14 22:58:34 -06:00
parent 88cf3f8da3
commit 95b089960b
90 changed files with 119 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/swervelib/SwerveModule.html
View File

@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Feb 14 22:49:37 CST 2023 -->
<!-- Generated by javadoc (17) on Tue Feb 14 22:57:26 CST 2023 -->
<title>SwerveModule</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -197,9 +197,9 @@ loadScripts(document, 'script');</script>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCANCoder()" class="member-name-link">getCANCoder</a>()</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the CANCoder absolute position.</div>
<div class="block">Get the absolute position.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModulePosition</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
@@ -207,9 +207,9 @@ loadScripts(document, 'script');</script>
<div class="block">Get the position of the swerve module.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelativeEncoder()" class="member-name-link">getRelativeEncoder</a>()</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelativePosition()" class="member-name-link">getRelativePosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the relative encoder angle in degrees.</div>
<div class="block">Get the relative angle in degrees.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
@@ -442,10 +442,10 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getCANCoder()">
<h3>getCANCoder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getCANCoder</span>()</div>
<div class="block">Get the CANCoder absolute position.</div>
<section class="detail" id="getAbsolutePosition()">
<h3>getAbsolutePosition</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getAbsolutePosition</span>()</div>
<div class="block">Get the absolute position.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Absolute encoder angle in degrees.</dd>
@@ -453,10 +453,10 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getRelativeEncoder()">
<h3>getRelativeEncoder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getRelativeEncoder</span>()</div>
<div class="block">Get the relative encoder angle in degrees.</div>
<section class="detail" id="getRelativePosition()">
<h3>getRelativePosition</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getRelativePosition</span>()</div>
<div class="block">Get the relative angle in degrees.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Angle in degrees.</dd>