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

Added documentation for packages

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-16 22:12:57 -06:00
parent 80b79c3ac9
commit 239b782d2a
111 changed files with 445 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/allpackages-index.html
View File

@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
<title>All Packages</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -55,27 +55,49 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="swervelib/package-summary.html">swervelib</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
</div>
<div class="col-first odd-row-color"><a href="swervelib/encoders/package-summary.html">swervelib.encoders</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">Absolute encoders for the swerve drive, all implement <a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
</div>
<div class="col-first even-row-color"><a href="swervelib/imu/package-summary.html">swervelib.imu</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">IMUs used for controlling the robot heading.</div>
</div>
<div class="col-first odd-row-color"><a href="swervelib/math/package-summary.html">swervelib.math</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">Mathematics for swerve drives.</div>
</div>
<div class="col-first even-row-color"><a href="swervelib/motors/package-summary.html">swervelib.motors</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">Swerve motor controller wrappers which implement <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="swervelib/parser/package-summary.html">swervelib.parser</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">JSON Parser for YAGSL configurations.</div>
</div>
<div class="col-first even-row-color"><a href="swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">Deserialize specific variables for outside the parser.</div>
</div>
<div class="col-first odd-row-color"><a href="swervelib/parser/json/package-summary.html">swervelib.parser.json</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">JSON Mapped classes for parsing configuration files.</div>
</div>
<div class="col-first even-row-color"><a href="swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">JSON Mapped Configuration types for modules.</div>
</div>
<div class="col-first odd-row-color"><a href="swervelib/simulation/package-summary.html">swervelib.simulation</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">Classes used to simulate the swerve drive.</div>
</div>
<div class="col-first even-row-color"><a href="swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">CTRE Physics Simulator.</div>
</div>
</div>
</main>
</div>