Updated docs

This commit is contained in:
thenetworkgrinch
2023-02-13 15:03:55 -06:00
parent 9f8c3f6b49
commit e8d248b68a
161 changed files with 2589 additions and 37454 deletions

View File

@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 14:36:54 CST 2023 -->
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 15:03:24 CST 2023 -->
<title>F-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -98,80 +98,62 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#f">f</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">PIDFConfig</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#f">f</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Feedforward value for PID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/CANCoderSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.encoders.<a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/CANCoderSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">CANCoderSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/encoders/CANCoderSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/SparkMaxEncoderSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.encoders.<a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.encoders.<a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/NavXSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/NavXSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">NavXSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/imu/NavXSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">Pigeon2Swerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/imu/Pigeon2Swerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">PigeonSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/imu/PigeonSwerve.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/SwerveIMU.html#factoryDefault()">factoryDefault()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/SwerveIMU.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">SwerveIMU</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/imu/SwerveIMU.html#factoryDefault()">factoryDefault()</a></span> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></span> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html#factoryDefaults()">factoryDefaults()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaults()">factoryDefaults()</a></span> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html#factoryDefaults()">factoryDefaults()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SwerveMotor</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SwerveMotor.html#factoryDefaults()">factoryDefaults()</a></span> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html#fakePos">fakePos</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveModule.html#fakePos">fakePos</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Current state.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html#feedforward">feedforward</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveModule.html#feedforward">feedforward</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Feedforward for drive motor during closed loop control.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html#field">field</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveDrive</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveDrive.html#field">field</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Field object.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib</a> - package frc.robot.subsystems.swervedrive2.swervelib</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/encoders/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.encoders</a> - package frc.robot.subsystems.swervedrive2.swervelib.encoders</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.imu</a> - package frc.robot.subsystems.swervedrive2.swervelib.imu</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/math/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.math</a> - package frc.robot.subsystems.swervedrive2.swervelib.math</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.motors</a> - package frc.robot.subsystems.swervedrive2.swervelib.motors</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser</a> - package frc.robot.subsystems.swervedrive2.swervelib.parser</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer</a> - package frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json</a> - package frc.robot.subsystems.swervedrive2.swervelib.parser.json</dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules</a> - package frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules</dt>
<dd>&nbsp;</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">X</a>&nbsp;<a href="index-23.html">Y</a>&nbsp;<a href="index-24.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
</main>