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>SparkMaxEncoderSwerve</title>
<!-- Generated by javadoc (17) -->
<title>SparkMaxEncoderSwerve (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.encoders, class: SparkMaxEncoderSwerve">
<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>
@@ -112,7 +111,8 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor)" class="member-name-link">SparkMaxEncoderSwerve</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor)</code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,int)" class="member-name-link">SparkMaxEncoderSwerve</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor,
int&nbsp;conversionFactor)</code></div>
<div class="col-last even-row-color">
<div class="block">Create the <code>AbsoluteEncoder</code> object as a duty cycle.</div>
</div>
@@ -188,13 +188,15 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor)">
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,int)">
<h3>SparkMaxEncoderSwerve</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SparkMaxEncoderSwerve</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SparkMaxEncoderSwerve</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor,
int&nbsp;conversionFactor)</span></div>
<div class="block">Create the <code>AbsoluteEncoder</code> object as a duty cycle. from the <code>CANSparkMax</code> motor.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>motor</code> - Motor to create the encoder from.</dd>
<dd><code>conversionFactor</code> - The conversion factor to set if the output is not from 0 to 360.</dd>
</dl>
</section>
</li>