Updated javadocs

This commit is contained in:
thenetworkgrinch
2023-08-09 16:23:30 -05:00
parent de4e35db62
commit 38c7bdba7d
156 changed files with 3972 additions and 33744 deletions

View File

@@ -1,18 +1,17 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
<title>swervelib.math</title>
<!-- Generated by javadoc (17) -->
<title>swervelib.math (YAGSL-Lib API)</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-04-08">
<meta name="description" content="declaration: package: swervelib.math">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
@@ -32,7 +31,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html#package">Help</a></li>
</ul>
</div>
@@ -61,8 +60,7 @@ loadScripts(document, 'script');</script>
<hr>
<div class="package-signature">package <span class="element-name">swervelib.math</span></div>
<section class="package-description" id="package-description">
<div class="block">Mathematics for swerve drives. Original second order kinematics was developed by Team 3181
<a href="https://github.com/pittsfordrobotics/ChargedUp2023/tree/master/src/main/java/com/team3181/lib/swerve">here.
<div class="block">Mathematics for swerve drives. Original second order kinematics was developed by Team 3181 <a href="https://github.com/pittsfordrobotics/ChargedUp2023/tree/master/src/main/java/com/team3181/lib/swerve">here.
</a></div>
</section>
<section class="summary">
@@ -92,12 +90,13 @@ loadScripts(document, 'script');</script>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate estimation.</div>
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate
estimation.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
speed.</div>
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules
states from chassis speed.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
@@ -109,8 +108,8 @@ loadScripts(document, 'script');</script>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to achieve a more
accurate estimation, originally made by Team 1466.</div>
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to
achieve a more accurate estimation, originally made by Team 1466.</div>
</div>
</div>
</div>