Updated docs

This commit is contained in:
thenetworkgrinch
2024-01-17 09:18:38 -06:00
parent 1ca3db242c
commit 889c85172f
108 changed files with 1609 additions and 370 deletions

View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveDrive</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib, class: SwerveDrive">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -554,6 +554,21 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="HEADING_CORRECTION_DEADBAND">
<h3>HEADING_CORRECTION_DEADBAND</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">HEADING_CORRECTION_DEADBAND</span></div>
<div class="block">Deadband for speeds in heading correction.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../constant-values.html#swervelib.SwerveDrive.HEADING_CORRECTION_DEADBAND">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="field">
<h3>field</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.smartdashboard.Field2d</span>&nbsp;<span class="element-name">field</span></div>
@@ -601,13 +616,6 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="correctionEnabled">
<h3>correctionEnabled</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">correctionEnabled</span></div>
<div class="block">Whether heading correction PID is currently active.</div>
</section>
</li>
<li>
<section class="detail" id="headingCorrection">
<h3>headingCorrection</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">headingCorrection</span></div>
@@ -615,6 +623,13 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="correctionEnabled">
<h3>correctionEnabled</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">correctionEnabled</span></div>
<div class="block">Whether heading correction PID is currently active.</div>
</section>
</li>
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></span>&nbsp;<span class="element-name">imu</span></div>
@@ -636,21 +651,6 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="HEADING_CORRECTION_DEADBAND">
<h3>HEADING_CORRECTION_DEADBAND</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">HEADING_CORRECTION_DEADBAND</span></div>
<div class="block">Deadband for speeds in heading correction.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../constant-values.html#swervelib.SwerveDrive.HEADING_CORRECTION_DEADBAND">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="lastHeadingRadians">
<h3>lastHeadingRadians</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">lastHeadingRadians</span></div>