Skip to content

Commit

Permalink
Deploying to javadoc from @ f94e44b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@quackitsquinn
quackitsquinn committed Jan 30, 2024
1 parent 2830396 commit 8936d96
Show file tree
Hide file tree
Showing 31 changed files with 2,921 additions and 26 deletions.
63 changes: 51 additions & 12 deletions javadoc/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,30 +65,69 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/Drive.html" title="class in frc.robot.subsystems">Drive</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Intake.html" title="class in frc.robot">Constants.Intake</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.MailboxBelts.html" title="class in frc.robot">Constants.MailboxBelts</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Constants for the Belts system.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.MailboxPneumatics.html" title="class in frc.robot">Constants.MailboxPneumatics</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The subsystem that represents the drivetrain.</div>
<div class="block">Constants for the Pneumatics system.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DriveFieldOriented.html" title="class in frc.robot.commands">DriveFieldOriented</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DeployMailbox.html" title="class in frc.robot.commands">DeployMailbox</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DeployPneumatics.html" title="class in frc.robot.commands">DeployPneumatics</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Command that extends the mailbox when started, and lowers the mailbox when ended.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/Drive.html" title="class in frc.robot.subsystems">Drive</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Drives the robot in field-oriented mode.</div>
<div class="block">The subsystem that represents the drivetrain.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DriveRobotOriented.html" title="class in frc.robot.commands">DriveRobotOriented</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DriveFieldOriented.html" title="class in frc.robot.commands">DriveFieldOriented</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Drives the robot in robot-oriented mode.</div>
<div class="block">Drives the robot in field-oriented mode.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/DriveRobotOriented.html" title="class in frc.robot.commands">DriveRobotOriented</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Drives the robot in robot-oriented mode.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Points the wheels toward the inside and stops the wheels from moving in any direction.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Main.html" title="class in frc.robot">Main</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/RobotContainer.html" title="class in frc.robot">RobotContainer</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/Intake.html" title="class in frc.robot.subsystems">Intake</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The intake of the robot.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/mailbox/Mailbox.html" title="class in frc.robot.subsystems.mailbox">Mailbox</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Subsystem for the mailbox that outputs game pieces from our robot.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox">MailboxBelts</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Subsystem for the mailbox belt.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/mailbox/MailboxPneumatics.html" title="class in frc.robot.subsystems.mailbox">MailboxPneumatics</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents the pistons that raise the Mailbox, which is the system that outputs gamepieces from
our robot</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Main.html" title="class in frc.robot">Main</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/RobotContainer.html" title="class in frc.robot">RobotContainer</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Singleton class that contains all the robot's subsystems, commands, and button bindings.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/RunBelts.html" title="class in frc.robot.commands">RunBelts</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Command that activates belts when started, and deactivates belts when ended.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/RunIntake.html" title="class in frc.robot.commands">RunIntake</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
</div>
</div>
</main>
Expand Down
2 changes: 2 additions & 0 deletions javadoc/allpackages-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/package-summary.html">frc.robot.subsystems</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/mailbox/package-summary.html">frc.robot.subsystems.mailbox</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</main>
</div>
Expand Down
51 changes: 51 additions & 0 deletions javadoc/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,57 @@ <h2 title="frc.robot">frc.robot.*</h2>
<div class="col-last even-row-color"><code>0</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.Intake.html" title="class in frc.robot">Constants.Intake</a></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">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.INTAKE_LIMIT_SWITCH_DIO_PORT">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_LIMIT_SWITCH_DIO_PORT">INTAKE_LIMIT_SWITCH_DIO_PORT</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.Intake.INTAKE_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_MOTOR_ID">INTAKE_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color"><code>0</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.INTAKE_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_MOTOR_SPEED">INTAKE_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color"><code>0.5</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.MailboxBelts.html" title="class in frc.robot">Constants.MailboxBelts</a></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">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxBelts.BELT_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELT_MOTOR_ID">BELT_MOTOR_ID</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxBelts.BELT_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELT_MOTOR_SPEED">BELT_MOTOR_SPEED</a></code></div>
<div class="col-last odd-row-color"><code>0.7</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.MailboxPneumatics.html" title="class in frc.robot">Constants.MailboxPneumatics</a></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">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxPneumatics.LEFT_SOLENOID_FORWARD_CHANNEL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxPneumatics.html#LEFT_SOLENOID_FORWARD_CHANNEL">LEFT_SOLENOID_FORWARD_CHANNEL</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxPneumatics.LEFT_SOLENOID_REVERSE_CHANNEL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxPneumatics.html#LEFT_SOLENOID_REVERSE_CHANNEL">LEFT_SOLENOID_REVERSE_CHANNEL</a></code></div>
<div class="col-last odd-row-color"><code>1</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxPneumatics.RIGHT_SOLENOID_FORWARD_CHANNEL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxPneumatics.html#RIGHT_SOLENOID_FORWARD_CHANNEL">RIGHT_SOLENOID_FORWARD_CHANNEL</a></code></div>
<div class="col-last even-row-color"><code>2</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxPneumatics.RIGHT_SOLENOID_REVERSE_CHANNEL">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxPneumatics.html#RIGHT_SOLENOID_REVERSE_CHANNEL">RIGHT_SOLENOID_REVERSE_CHANNEL</a></code></div>
<div class="col-last odd-row-color"><code>3</code></div>
</div>
</li>
</ul>
</section>
</main>
Expand Down
1 change: 1 addition & 0 deletions javadoc/element-list
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
frc.robot
frc.robot.commands
frc.robot.subsystems
frc.robot.subsystems.mailbox
Loading

0 comments on commit 8936d96

Please sign in to comment.