Updated javadocs

This commit is contained in:
thenetworkgrinch
2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions

View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<title>SwerveDriveJson</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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="declaration: package: swervelib.parser.json, class: SwerveDriveJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -97,21 +97,11 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color">
<div class="block">Invert the IMU of the robot.</div>
</div>
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second even-row-color"><code><a href="#modules" class="member-name-link">modules</a></code></div>
<div class="col-last even-row-color">
<div class="block">Maximum robot speed in feet per second.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second odd-row-color"><code><a href="#modules" class="member-name-link">modules</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Module JSONs in order clockwise order starting from front left.</div>
</div>
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#optimalVoltage" class="member-name-link">optimalVoltage</a></code></div>
<div class="col-last even-row-color">
<div class="block">Optimal voltage to compensate to and base feedforward calculations off of.</div>
</div>
</div>
</section>
</li>
@@ -147,20 +137,6 @@ loadScripts(document, 'script');</script>
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="maxSpeed">
<h3>maxSpeed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">maxSpeed</span></div>
<div class="block">Maximum robot speed in feet per second.</div>
</section>
</li>
<li>
<section class="detail" id="optimalVoltage">
<h3>optimalVoltage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">optimalVoltage</span></div>
<div class="block">Optimal voltage to compensate to and base feedforward calculations off of.</div>
</section>
</li>
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></span>&nbsp;<span class="element-name">imu</span></div>