Skip to content

Commit

Permalink
Deploying to javadoc from @ 82848c9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
AraReighard committed Mar 20, 2024
1 parent 0a8dff0 commit ae0e571
Show file tree
Hide file tree
Showing 15 changed files with 945 additions and 403 deletions.
160 changes: 85 additions & 75 deletions javadoc/allclasses-index.html

Large diffs are not rendered by default.

221 changes: 0 additions & 221 deletions javadoc/frc/robot/Constants.Drive.DrivePerspectiveOptions.html

This file was deleted.

72 changes: 24 additions & 48 deletions javadoc/frc/robot/Constants.Drive.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
Expand Down Expand Up @@ -82,21 +82,6 @@ <h1 title="Class Constants.Drive" class="title">Class Constants.Drive</h1>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.Drive.DrivePerspectiveOptions.html" class="type-name-link" title="enum class in frc.robot">Constants.Drive.DrivePerspectiveOptions</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
Expand All @@ -106,47 +91,44 @@ <h2>Field Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="Constants.Drive.DrivePerspectiveOptions.html" title="enum class in frc.robot">Constants.Drive.DrivePerspectiveOptions</a></code></div>
<div class="col-second even-row-color"><code><a href="#currentDrivePerspective" class="member-name-link">currentDrivePerspective</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static double</code></div>
<div class="col-second odd-row-color"><code><a href="#DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE" class="member-name-link">DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The distance from the center of the robot to any of the swerve modules.</div>
</div>
<div class="col-first even-row-color"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
<div class="col-second even-row-color"><code><a href="#EMPTY_TRANSLATION" class="member-name-link">EMPTY_TRANSLATION</a></code></div>
<div class="col-first even-row-color"><code>static double</code></div>
<div class="col-second even-row-color"><code><a href="#DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE" class="member-name-link">DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Empty translation to prevent creating 2 Translation2ds every time the drive train stops.</div>
<div class="block">The distance from the center of the robot to any of the swerve modules.</div>
</div>
<div class="col-first odd-row-color"><code>static double</code></div>
<div class="col-second odd-row-color"><code><a href="#MAX_ANGULAR_SPEED" class="member-name-link">MAX_ANGULAR_SPEED</a></code></div>
<div class="col-first odd-row-color"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
<div class="col-second odd-row-color"><code><a href="#EMPTY_TRANSLATION" class="member-name-link">EMPTY_TRANSLATION</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The max speed the robot can rotate</div>
<div class="block">Empty translation to prevent creating 2 Translation2ds every time the drive train stops.</div>
</div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#MAX_NORMAL_ANGULAR_SPEED" class="member-name-link">MAX_NORMAL_ANGULAR_SPEED</a></code></div>
<div class="col-first even-row-color"><code>static double</code></div>
<div class="col-second even-row-color"><code><a href="#MAX_ANGULAR_SPEED" class="member-name-link">MAX_ANGULAR_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">The max angular speed (in randians) for the robot when not sprinting</div>
<div class="block">The max speed the robot can rotate</div>
</div>
<div class="col-first odd-row-color"><code>static final double</code></div>
<div class="col-second odd-row-color"><code><a href="#MAX_NORMAL_SPEED" class="member-name-link">MAX_NORMAL_SPEED</a></code></div>
<div class="col-second odd-row-color"><code><a href="#MAX_NORMAL_ANGULAR_SPEED" class="member-name-link">MAX_NORMAL_ANGULAR_SPEED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The max speed for the robot when not sprinting (in m/s)</div>
<div class="block">The max angular speed (in randians) for the robot when not sprinting</div>
</div>
<div class="col-first even-row-color"><code>static double</code></div>
<div class="col-second even-row-color"><code><a href="#MAX_SPEED" class="member-name-link">MAX_SPEED</a></code></div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#MAX_NORMAL_SPEED" class="member-name-link">MAX_NORMAL_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">The max speed the robot can go in m/s</div>
<div class="block">The max speed for the robot when not sprinting (in m/s)</div>
</div>
<div class="col-first odd-row-color"><code>static com.pathplanner.lib.util.PIDConstants</code></div>
<div class="col-second odd-row-color"><code><a href="#ROTATION_DRIVE_PID" class="member-name-link">ROTATION_DRIVE_PID</a></code></div>
<div class="col-first odd-row-color"><code>static double</code></div>
<div class="col-second odd-row-color"><code><a href="#MAX_SPEED" class="member-name-link">MAX_SPEED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The Rotation Drive PID for the robot.</div>
<div class="block">The max speed the robot can go in m/s</div>
</div>
<div class="col-first even-row-color"><code>static com.pathplanner.lib.util.PIDConstants</code></div>
<div class="col-second even-row-color"><code><a href="#TRANSLATION_DRIVE_PID" class="member-name-link">TRANSLATION_DRIVE_PID</a></code></div>
<div class="col-second even-row-color"><code><a href="#ROTATION_DRIVE_PID" class="member-name-link">ROTATION_DRIVE_PID</a></code></div>
<div class="col-last even-row-color">
<div class="block">The Rotation Drive PID for the robot.</div>
</div>
<div class="col-first odd-row-color"><code>static com.pathplanner.lib.util.PIDConstants</code></div>
<div class="col-second odd-row-color"><code><a href="#TRANSLATION_DRIVE_PID" class="member-name-link">TRANSLATION_DRIVE_PID</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The Translation Drive PID for the robot.</div>
</div>
</div>
Expand Down Expand Up @@ -184,12 +166,6 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="currentDrivePerspective">
<h3>currentDrivePerspective</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Constants.Drive.DrivePerspectiveOptions.html" title="enum class in frc.robot">Constants.Drive.DrivePerspectiveOptions</a></span>&nbsp;<span class="element-name">currentDrivePerspective</span></div>
</section>
</li>
<li>
<section class="detail" id="EMPTY_TRANSLATION">
<h3>EMPTY_TRANSLATION</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Translation2d</span>&nbsp;<span class="element-name">EMPTY_TRANSLATION</span></div>
Expand Down
60 changes: 49 additions & 11 deletions javadoc/frc/robot/RobotContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -245,24 +245,40 @@ <h2>Field Summary</h2>
<div class="col-last even-row-color">
<div class="block">Singleton instance of <a href="commands/RunIntakeReverse.html" title="class in frc.robot.commands"><code>RunIntakeReverse</code></a> for the whole robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="commands/StartCamera.html" title="class in frc.robot.commands">StartCamera</a></code></div>
<div class="col-second odd-row-color"><code><a href="#startIntakeCamera" class="member-name-link">startIntakeCamera</a></code></div>
<div class="col-first odd-row-color"><code>static <a href="commands/drive/SetDrivePerspectiveFieldOriented.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveFieldOriented</a></code></div>
<div class="col-second odd-row-color"><code><a href="#setDrivePerspectiveFieldOriented" class="member-name-link">setDrivePerspectiveFieldOriented</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Singleton instance of the intake <a href="commands/StartCamera.html" title="class in frc.robot.commands"><code>StartCamera</code></a> for the whole robot.</div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveFieldOriented.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveFieldOriented</code></a> for the whole robot.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto">TaxiAuto</a></code></div>
<div class="col-second even-row-color"><code><a href="#taxiAuto" class="member-name-link">taxiAuto</a></code></div>
<div class="col-first even-row-color"><code>static <a href="commands/drive/SetDrivePerspectiveFieldOrientedHeadingSnapping.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveFieldOrientedHeadingSnapping</a></code></div>
<div class="col-second even-row-color"><code><a href="#setDrivePerspectiveFieldOrientedHeadingSnapping" class="member-name-link">setDrivePerspectiveFieldOrientedHeadingSnapping</a></code></div>
<div class="col-last even-row-color">
<div class="block">Singleton instance of <a href="commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto"><code>TaxiAuto</code></a> for the whole robot.</div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveFieldOrientedHeadingSnapping.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveFieldOrientedHeadingSnapping</code></a> for the whole
robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="subsystems/UrMom.html" title="class in frc.robot.subsystems">UrMom</a></code></div>
<div class="col-second odd-row-color"><code><a href="#urMom" class="member-name-link">urMom</a></code></div>
<div class="col-first odd-row-color"><code>static <a href="commands/drive/SetDrivePerspectiveRobotOriented.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveRobotOriented</a></code></div>
<div class="col-second odd-row-color"><code><a href="#setDrivePerspectiveRobotOriented" class="member-name-link">setDrivePerspectiveRobotOriented</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Singleton instance of <a href="subsystems/UrMom.html" title="class in frc.robot.subsystems"><code>UrMom</code></a> for the whole robot.</div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveRobotOriented.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveRobotOriented</code></a> for the whole robot.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="commands/drive/ZeroGyro.html" title="class in frc.robot.commands.drive">ZeroGyro</a></code></div>
<div class="col-second even-row-color"><code><a href="#zeroGyro" class="member-name-link">zeroGyro</a></code></div>
<div class="col-first even-row-color"><code>static <a href="commands/StartCamera.html" title="class in frc.robot.commands">StartCamera</a></code></div>
<div class="col-second even-row-color"><code><a href="#startIntakeCamera" class="member-name-link">startIntakeCamera</a></code></div>
<div class="col-last even-row-color">
<div class="block">Singleton instance of the intake <a href="commands/StartCamera.html" title="class in frc.robot.commands"><code>StartCamera</code></a> for the whole robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto">TaxiAuto</a></code></div>
<div class="col-second odd-row-color"><code><a href="#taxiAuto" class="member-name-link">taxiAuto</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Singleton instance of <a href="commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto"><code>TaxiAuto</code></a> for the whole robot.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="subsystems/UrMom.html" title="class in frc.robot.subsystems">UrMom</a></code></div>
<div class="col-second even-row-color"><code><a href="#urMom" class="member-name-link">urMom</a></code></div>
<div class="col-last even-row-color">
<div class="block">Singleton instance of <a href="subsystems/UrMom.html" title="class in frc.robot.subsystems"><code>UrMom</code></a> for the whole robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="commands/drive/ZeroGyro.html" title="class in frc.robot.commands.drive">ZeroGyro</a></code></div>
<div class="col-second odd-row-color"><code><a href="#zeroGyro" class="member-name-link">zeroGyro</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Singleton instance of <a href="commands/drive/ZeroGyro.html" title="class in frc.robot.commands.drive"><code>ZeroGyro</code></a> for the whole robot.</div>
</div>
</div>
Expand Down Expand Up @@ -527,6 +543,28 @@ <h3>startIntakeCamera</h3>
</section>
</li>
<li>
<section class="detail" id="setDrivePerspectiveFieldOriented">
<h3>setDrivePerspectiveFieldOriented</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/drive/SetDrivePerspectiveFieldOriented.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveFieldOriented</a></span>&nbsp;<span class="element-name">setDrivePerspectiveFieldOriented</span></div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveFieldOriented.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveFieldOriented</code></a> for the whole robot.</div>
</section>
</li>
<li>
<section class="detail" id="setDrivePerspectiveFieldOrientedHeadingSnapping">
<h3>setDrivePerspectiveFieldOrientedHeadingSnapping</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/drive/SetDrivePerspectiveFieldOrientedHeadingSnapping.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveFieldOrientedHeadingSnapping</a></span>&nbsp;<span class="element-name">setDrivePerspectiveFieldOrientedHeadingSnapping</span></div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveFieldOrientedHeadingSnapping.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveFieldOrientedHeadingSnapping</code></a> for the whole
robot.</div>
</section>
</li>
<li>
<section class="detail" id="setDrivePerspectiveRobotOriented">
<h3>setDrivePerspectiveRobotOriented</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/drive/SetDrivePerspectiveRobotOriented.html" title="class in frc.robot.commands.drive">SetDrivePerspectiveRobotOriented</a></span>&nbsp;<span class="element-name">setDrivePerspectiveRobotOriented</span></div>
<div class="block">Singleton instance of <a href="commands/drive/SetDrivePerspectiveRobotOriented.html" title="class in frc.robot.commands.drive"><code>SetDrivePerspectiveRobotOriented</code></a> for the whole robot.</div>
</section>
</li>
<li>
<section class="detail" id="moveAwayFromAmp">
<h3>moveAwayFromAmp</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/auto/MoveAwayFromAmp.html" title="class in frc.robot.commands.auto">MoveAwayFromAmp</a></span>&nbsp;<span class="element-name">moveAwayFromAmp</span></div>
Expand Down
Loading

0 comments on commit ae0e571

Please sign in to comment.