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>Class Hierarchy</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -97,15 +97,15 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<h1 class="title">Hierarchy For All Packages</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/encoders/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.encoders</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/imu/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.imu</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/math/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.math</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/motors/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.motors</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.parser</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/package-tree.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules</a></li>
<li><a href="swervelib/package-tree.html">swervelib</a>, </li>
<li><a href="swervelib/encoders/package-tree.html">swervelib.encoders</a>, </li>
<li><a href="swervelib/imu/package-tree.html">swervelib.imu</a>, </li>
<li><a href="swervelib/math/package-tree.html">swervelib.math</a>, </li>
<li><a href="swervelib/motors/package-tree.html">swervelib.motors</a>, </li>
<li><a href="swervelib/parser/package-tree.html">swervelib.parser</a>, </li>
<li><a href="swervelib/parser/deserializer/package-tree.html">swervelib.parser.deserializer</a>, </li>
<li><a href="swervelib/parser/json/package-tree.html">swervelib.parser.json</a>, </li>
<li><a href="swervelib/parser/json/modules/package-tree.html">swervelib.parser.json.modules</a></li>
</ul>
</div>
<div class="contentContainer">
@@ -114,55 +114,55 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink"><span class="typeNameLink">Object</span></a>
<ul>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/BoolMotorJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules"><span class="typeNameLink">BoolMotorJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/ControllerPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">ControllerPropertiesJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">DeviceJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/LocationJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules"><span class="typeNameLink">LocationJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/ModuleJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">ModuleJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigDouble.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">MotorConfigDouble</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigInt.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">MotorConfigInt</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/PhysicalPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">PhysicalPropertiesJson</span></a></li>
<li class="circle">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"><span class="typeNameLink">PIDFConfig</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">PIDFPropertiesJson</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/PIDFRange.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer"><span class="typeNameLink">PIDFRange</span></a></li>
<li class="circle">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"><span class="typeNameLink">SwerveAbsoluteEncoder</span></a>
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules"><span class="typeNameLink">BoolMotorJson</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">ControllerPropertiesJson</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">DeviceJson</span></a></li>
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules"><span class="typeNameLink">LocationJson</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">ModuleJson</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json"><span class="typeNameLink">MotorConfigDouble</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json"><span class="typeNameLink">MotorConfigInt</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">PhysicalPropertiesJson</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser"><span class="typeNameLink">PIDFConfig</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">PIDFPropertiesJson</span></a></li>
<li class="circle">swervelib.parser.deserializer.<a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer"><span class="typeNameLink">PIDFRange</span></a></li>
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><span class="typeNameLink">SwerveAbsoluteEncoder</span></a>
<ul>
<li class="circle">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"><span class="typeNameLink">CANCoderSwerve</span></a></li>
<li class="circle">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"><span class="typeNameLink">SparkMaxEncoderSwerve</span></a></li>
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders"><span class="typeNameLink">CANCoderSwerve</span></a></li>
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><span class="typeNameLink">SparkMaxEncoderSwerve</span></a></li>
</ul>
</li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.<a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveController.html" title="class in frc.robot.subsystems.swervedrive2.swervelib"><span class="typeNameLink">SwerveController</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveControllerConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">SwerveControllerConfiguration</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.<a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive2.swervelib"><span class="typeNameLink">SwerveDrive</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">SwerveDriveConfiguration</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">SwerveDriveJson</span></a></li>
<li class="circle">swervelib.<a href="swervelib/SwerveController.html" title="class in swervelib"><span class="typeNameLink">SwerveController</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><span class="typeNameLink">SwerveControllerConfiguration</span></a></li>
<li class="circle">swervelib.<a href="swervelib/SwerveDrive.html" title="class in swervelib"><span class="typeNameLink">SwerveDrive</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><span class="typeNameLink">SwerveDriveConfiguration</span></a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">SwerveDriveJson</span></a></li>
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveKinematics
<ul>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.math.<a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math"><span class="typeNameLink">SwerveKinematics2</span></a></li>
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math"><span class="typeNameLink">SwerveKinematics2</span></a></li>
</ul>
</li>
<li class="circle">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"><span class="typeNameLink">SwerveIMU</span></a>
<li class="circle">swervelib.imu.<a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><span class="typeNameLink">SwerveIMU</span></a>
<ul>
<li class="circle">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"><span class="typeNameLink">NavXSwerve</span></a></li>
<li class="circle">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"><span class="typeNameLink">Pigeon2Swerve</span></a></li>
<li class="circle">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"><span class="typeNameLink">PigeonSwerve</span></a></li>
<li class="circle">swervelib.imu.<a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu"><span class="typeNameLink">NavXSwerve</span></a></li>
<li class="circle">swervelib.imu.<a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu"><span class="typeNameLink">Pigeon2Swerve</span></a></li>
<li class="circle">swervelib.imu.<a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu"><span class="typeNameLink">PigeonSwerve</span></a></li>
</ul>
</li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.math.<a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveMath.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math"><span class="typeNameLink">SwerveMath</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.<a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib"><span class="typeNameLink">SwerveModule</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">SwerveModuleConfiguration</span></a></li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">SwerveModulePhysicalCharacteristics</span></a></li>
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveMath.html" title="class in swervelib.math"><span class="typeNameLink">SwerveMath</span></a></li>
<li class="circle">swervelib.<a href="swervelib/SwerveModule.html" title="class in swervelib"><span class="typeNameLink">SwerveModule</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><span class="typeNameLink">SwerveModuleConfiguration</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><span class="typeNameLink">SwerveModulePhysicalCharacteristics</span></a></li>
<li class="circle">edu.wpi.first.math.kinematics.SwerveModuleState (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;T&gt;)
<ul>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.math.<a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math"><span class="typeNameLink">SwerveModuleState2</span></a></li>
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><span class="typeNameLink">SwerveModuleState2</span></a></li>
</ul>
</li>
<li class="circle">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"><span class="typeNameLink">SwerveMotor</span></a>
<li class="circle">swervelib.motors.<a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><span class="typeNameLink">SwerveMotor</span></a>
<ul>
<li class="circle">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"><span class="typeNameLink">SparkMaxSwerve</span></a></li>
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors"><span class="typeNameLink">SparkMaxSwerve</span></a></li>
</ul>
</li>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">SwerveParser</span></a></li>
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser"><span class="typeNameLink">SwerveParser</span></a></li>
</ul>
</li>
</ul>
@@ -174,7 +174,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink"><span class="typeNameLink">Enum</span></a>&lt;E&gt; (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;T&gt;, java.io.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>)
<ul>
<li class="circle">frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive2.swervelib.motors"><span class="typeNameLink">SparkMaxSwerve.SparkMAX_slotIdx</span></a></li>
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in swervelib.motors"><span class="typeNameLink">SparkMaxSwerve.SparkMAX_slotIdx</span></a></li>
</ul>
</li>
</ul>