Skip to content

Commit

Permalink
Deploying to javadoc from @ 6fb05bd 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
AraReighard committed Feb 13, 2024
1 parent e67b68e commit bcfccab
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 10 deletions.
52 changes: 44 additions & 8 deletions javadoc/frc/robot/Constants.Drive.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,35 @@ <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 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">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 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">Empty translation to prevent creating 2 Translation2ds every time the drive train stops.</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_ANGULAR_SPEED" class="member-name-link">MAX_ANGULAR_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">The max speed the robot can rotate</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-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 max speed the robot can rotate</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 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 com.pathplanner.lib.util.PIDConstants</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 max speed the robot can go</div>
<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>
</section>
Expand Down Expand Up @@ -150,7 +165,7 @@ <h3>EMPTY_TRANSLATION</h3>
<section class="detail" id="MAX_SPEED">
<h3>MAX_SPEED</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">MAX_SPEED</span></div>
<div class="block">The max speed the robot can go</div>
<div class="block">The max speed the robot can go in m/s</div>
</section>
</li>
<li>
Expand All @@ -160,6 +175,27 @@ <h3>MAX_ANGULAR_SPEED</h3>
<div class="block">The max speed the robot can rotate</div>
</section>
</li>
<li>
<section class="detail" id="DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE">
<h3>DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE</span></div>
<div class="block">The distance from the center of the robot to any of the swerve modules.</div>
</section>
</li>
<li>
<section class="detail" id="TRANSLATION_DRIVE_PID">
<h3>TRANSLATION_DRIVE_PID</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">com.pathplanner.lib.util.PIDConstants</span>&nbsp;<span class="element-name">TRANSLATION_DRIVE_PID</span></div>
<div class="block">The Translation Drive PID for the robot.</div>
</section>
</li>
<li>
<section class="detail" id="ROTATION_DRIVE_PID">
<h3>ROTATION_DRIVE_PID</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">com.pathplanner.lib.util.PIDConstants</span>&nbsp;<span class="element-name">ROTATION_DRIVE_PID</span></div>
<div class="block">The Rotation Drive PID for the robot.</div>
</section>
</li>
</ul>
</section>
</li>
Expand Down
14 changes: 13 additions & 1 deletion javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,10 @@ <h2 class="title" id="I:D">D</h2>
<dd>
<div class="block">How far in inches we want to be from the target when we shoot</div>
</dd>
<dt><a href="frc/robot/Constants.Drive.html#DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE" class="member-name-link">DISTANCE_ROBOT_CENTER_TO_SWERVE_MODULE</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The distance from the center of the robot to any of the swerve modules.</div>
</dd>
<dt><a href="frc/robot/RobotContainer.html#drive" class="member-name-link">drive</a> - Static variable in class frc.robot.<a href="frc/robot/RobotContainer.html" title="class in frc.robot">RobotContainer</a></dt>
<dd>
<div class="block">Singleton instance of <a href="frc/robot/subsystems/Drive.html" title="class in frc.robot.subsystems"><code>Drive</code></a> for the whole robot.</div>
Expand Down Expand Up @@ -597,7 +601,7 @@ <h2 class="title" id="I:M">M</h2>
</dd>
<dt><a href="frc/robot/Constants.Drive.html#MAX_SPEED" class="member-name-link">MAX_SPEED</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The max speed the robot can go</div>
<div class="block">The max speed the robot can go in m/s</div>
</dd>
<dt><a href="frc/robot/Constants.Limelight.AimingLimelight.html#MOUNT_ANGLE" class="member-name-link">MOUNT_ANGLE</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Limelight.AimingLimelight.html" title="class in frc.robot">Constants.Limelight.AimingLimelight</a></dt>
<dd>
Expand Down Expand Up @@ -663,6 +667,10 @@ <h2 class="title" id="I:R">R</h2>
<dd>&nbsp;</dd>
<dt><a href="frc/robot/Robot.html#robotPeriodic()" class="member-name-link">robotPeriodic()</a> - Method in class frc.robot.<a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></dt>
<dd>&nbsp;</dd>
<dt><a href="frc/robot/Constants.Drive.html#ROTATION_DRIVE_PID" class="member-name-link">ROTATION_DRIVE_PID</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The Rotation Drive PID for the robot.</div>
</dd>
<dt><a href="frc/robot/subsystems/mailbox/MailboxBelts.html#runBelts()" class="member-name-link">runBelts()</a> - Method in class frc.robot.subsystems.mailbox.<a href="frc/robot/subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox">MailboxBelts</a></dt>
<dd>
<div class="block">Runs the belt.</div>
Expand Down Expand Up @@ -733,6 +741,10 @@ <h2 class="title" id="I:T">T</h2>
<dd>&nbsp;</dd>
<dt><a href="frc/robot/Robot.html#testPeriodic()" class="member-name-link">testPeriodic()</a> - Method in class frc.robot.<a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></dt>
<dd>&nbsp;</dd>
<dt><a href="frc/robot/Constants.Drive.html#TRANSLATION_DRIVE_PID" class="member-name-link">TRANSLATION_DRIVE_PID</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The Translation Drive PID for the robot.</div>
</dd>
<dt><a href="frc/robot/Constants.Limelight.AimingLimelight.html#TURN_DONE_THRESHOLD" class="member-name-link">TURN_DONE_THRESHOLD</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Limelight.AimingLimelight.html" title="class in frc.robot">Constants.Limelight.AimingLimelight</a></dt>
<dd>
<div class="block">When we're at or below this number of degrees from where we want to be, we'll consider the
Expand Down
Loading

0 comments on commit bcfccab

Please sign in to comment.