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

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

39
docs/swervelib/parser/package-summary.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>swervelib.parser</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span class="element-name">swervelib.parser</span></div>
<section class="package-description" id="package-description">
<div class="block">JSON Parser for YAGSL configurations.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
@@ -69,21 +72,37 @@ 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="../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="deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">Deserialize specific variables for outside the parser.</div>
</div>
<div class="col-first even-row-color"><a href="json/package-summary.html">swervelib.parser.json</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">JSON Mapped classes for parsing configuration files.</div>
</div>
<div class="col-first odd-row-color"><a href="../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="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
</div>
<div class="col-first even-row-color"><a href="../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="../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="../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="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="../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>
</div>
</li>