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

Updated javadocs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/swervelib/parser/SwerveModuleConfiguration.html
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>SwerveModuleConfiguration</title>
<!-- Generated by javadoc (17) -->
<title>SwerveModuleConfiguration (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.parser, class: SwerveModuleConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="class-declaration-page">
@@ -36,7 +35,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
@@ -397,7 +396,8 @@ loadScripts(document, 'script');</script>
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
<dd><code>maxSpeed</code> - Maximum speed in meters per second.</dd>
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
<dd><code>angleMotorEncoderPulsePerRevolution</code> - The encoder pulse per revolution for the angle motor encoder.</dd>
<dd><code>angleMotorEncoderPulsePerRevolution</code> - The encoder pulse per revolution for the angle motor
encoder.</dd>
<dd><code>name</code> - The name for the swerve module.</dd>
</dl>
</section>
@@ -416,8 +416,8 @@ loadScripts(document, 'script');</script>
double&nbsp;maxSpeed,
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics,
<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>&nbsp;name)</span></div>
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive motor are not
inverted.</div>
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive
motor are not inverted.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>driveMotor</code> - Drive <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</dd>