Skip to content

Commit

Permalink
Deploying to javadoc from @ 0a16be3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
quackitsquinn committed Jan 30, 2024
1 parent 8936d96 commit 2f7aee0
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 90 deletions.
8 changes: 6 additions & 2 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<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/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-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Deploys the mailbox pneumatics and runs the belts; effectively deploys the mailbox on the bot.</div>
</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>
Expand Down Expand Up @@ -127,7 +129,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<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 class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Command that runs the intake on the robot.</div>
</div>
</div>
</div>
</main>
Expand Down
77 changes: 13 additions & 64 deletions javadoc/frc/robot/RobotContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,47 +90,31 @@ <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="commands/DeployPneumatics.html" title="class in frc.robot.commands">DeployPneumatics</a></code></div>
<div class="col-second even-row-color"><code><a href="#deployPneumatics" class="member-name-link">deployPneumatics</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="subsystems/Drive.html" title="class in frc.robot.subsystems">Drive</a></code></div>
<div class="col-second odd-row-color"><code><a href="#drive" class="member-name-link">drive</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Singleton instance of <a href="subsystems/Drive.html" title="class in frc.robot.subsystems"><code>Drive</code></a></div>
<div class="col-first even-row-color"><code>static <a href="subsystems/Drive.html" title="class in frc.robot.subsystems">Drive</a></code></div>
<div class="col-second even-row-color"><code><a href="#drive" class="member-name-link">drive</a></code></div>
<div class="col-last even-row-color">
<div class="block">Singleton instance of <a href="subsystems/Drive.html" title="class in frc.robot.subsystems"><code>Drive</code></a> for the whole robot.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="commands/DriveFieldOriented.html" title="class in frc.robot.commands">DriveFieldOriented</a></code></div>
<div class="col-second even-row-color"><code><a href="#driveFieldOriented" class="member-name-link">driveFieldOriented</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static edu.wpi.first.wpilibj2.command.button.CommandXboxController</code></div>
<div class="col-second odd-row-color"><code><a href="#driverController" class="member-name-link">driverController</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Xbox controller for the driver.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="commands/DriveRobotOriented.html" title="class in frc.robot.commands">DriveRobotOriented</a></code></div>
<div class="col-second even-row-color"><code><a href="#driveRobotOriented" class="member-name-link">driveRobotOriented</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="commands/EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></code></div>
<div class="col-second odd-row-color"><code><a href="#enterXMode" class="member-name-link">enterXMode</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static <a href="subsystems/Intake.html" title="class in frc.robot.subsystems">Intake</a></code></div>
<div class="col-second even-row-color"><code><a href="#intake" class="member-name-link">intake</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">Singleton instance of <a href="subsystems/Intake.html" title="class in frc.robot.subsystems"><code>Intake</code></a> for the whole robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox">MailboxBelts</a></code></div>
<div class="col-second odd-row-color"><code><a href="#mailboxBelts" class="member-name-link">mailboxBelts</a></code></div>
<div class="col-last odd-row-color">
<div class="block">mailboxBelts object for the MailboxBelts class</div>
<div class="block">Singleton instance of <a href="subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox"><code>MailboxBelts</code></a> for the whole robot.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="subsystems/mailbox/MailboxPneumatics.html" title="class in frc.robot.subsystems.mailbox">MailboxPneumatics</a></code></div>
<div class="col-second even-row-color"><code><a href="#mailboxPneumatics" class="member-name-link">mailboxPneumatics</a></code></div>
<div class="col-last even-row-color">
<div class="block">mailboxPneumatics object for the MailboxPneumatics class</div>
<div class="block">Singleton instance of <a href="subsystems/mailbox/MailboxPneumatics.html" title="class in frc.robot.subsystems.mailbox"><code>MailboxPneumatics</code></a> for the whole robot.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="commands/RunBelts.html" title="class in frc.robot.commands">RunBelts</a></code></div>
<div class="col-second odd-row-color"><code><a href="#runBelts" class="member-name-link">runBelts</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static <a href="commands/RunIntake.html" title="class in frc.robot.commands">RunIntake</a></code></div>
<div class="col-second even-row-color"><code><a href="#runIntake" class="member-name-link">runIntake</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
Expand Down Expand Up @@ -226,63 +210,28 @@ <h2>Field Details</h2>
<section class="detail" id="drive">
<h3>drive</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="subsystems/Drive.html" title="class in frc.robot.subsystems">Drive</a></span>&nbsp;<span class="element-name">drive</span></div>
<div class="block">Singleton instance of <a href="subsystems/Drive.html" title="class in frc.robot.subsystems"><code>Drive</code></a></div>
<div class="block">Singleton instance of <a href="subsystems/Drive.html" title="class in frc.robot.subsystems"><code>Drive</code></a> for the whole robot.</div>
</section>
</li>
<li>
<section class="detail" id="mailboxPneumatics">
<h3>mailboxPneumatics</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="subsystems/mailbox/MailboxPneumatics.html" title="class in frc.robot.subsystems.mailbox">MailboxPneumatics</a></span>&nbsp;<span class="element-name">mailboxPneumatics</span></div>
<div class="block">mailboxPneumatics object for the MailboxPneumatics class</div>
<div class="block">Singleton instance of <a href="subsystems/mailbox/MailboxPneumatics.html" title="class in frc.robot.subsystems.mailbox"><code>MailboxPneumatics</code></a> for the whole robot.</div>
</section>
</li>
<li>
<section class="detail" id="mailboxBelts">
<h3>mailboxBelts</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox">MailboxBelts</a></span>&nbsp;<span class="element-name">mailboxBelts</span></div>
<div class="block">mailboxBelts object for the MailboxBelts class</div>
<div class="block">Singleton instance of <a href="subsystems/mailbox/MailboxBelts.html" title="class in frc.robot.subsystems.mailbox"><code>MailboxBelts</code></a> for the whole robot.</div>
</section>
</li>
<li>
<section class="detail" id="intake">
<h3>intake</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="subsystems/Intake.html" title="class in frc.robot.subsystems">Intake</a></span>&nbsp;<span class="element-name">intake</span></div>
</section>
</li>
<li>
<section class="detail" id="driveRobotOriented">
<h3>driveRobotOriented</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/DriveRobotOriented.html" title="class in frc.robot.commands">DriveRobotOriented</a></span>&nbsp;<span class="element-name">driveRobotOriented</span></div>
</section>
</li>
<li>
<section class="detail" id="driveFieldOriented">
<h3>driveFieldOriented</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/DriveFieldOriented.html" title="class in frc.robot.commands">DriveFieldOriented</a></span>&nbsp;<span class="element-name">driveFieldOriented</span></div>
</section>
</li>
<li>
<section class="detail" id="enterXMode">
<h3>enterXMode</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></span>&nbsp;<span class="element-name">enterXMode</span></div>
</section>
</li>
<li>
<section class="detail" id="deployPneumatics">
<h3>deployPneumatics</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/DeployPneumatics.html" title="class in frc.robot.commands">DeployPneumatics</a></span>&nbsp;<span class="element-name">deployPneumatics</span></div>
</section>
</li>
<li>
<section class="detail" id="runBelts">
<h3>runBelts</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/RunBelts.html" title="class in frc.robot.commands">RunBelts</a></span>&nbsp;<span class="element-name">runBelts</span></div>
</section>
</li>
<li>
<section class="detail" id="runIntake">
<h3>runIntake</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="commands/RunIntake.html" title="class in frc.robot.commands">RunIntake</a></span>&nbsp;<span class="element-name">runIntake</span></div>
<div class="block">Singleton instance of <a href="subsystems/Intake.html" title="class in frc.robot.subsystems"><code>Intake</code></a> for the whole robot.</div>
</section>
</li>
<li>
Expand Down
5 changes: 3 additions & 2 deletions javadoc/frc/robot/commands/DeployMailbox.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ <h1 title="Class DeployMailbox" class="title">Class DeployMailbox</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DeployMailbox</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.ParallelCommandGroup</span></div>
<div class="block">Deploys the mailbox pneumatics and runs the belts; effectively deploys the mailbox on the bot.</div>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down Expand Up @@ -112,7 +113,7 @@ <h2>Constructor Summary</h2>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DeployMailbox</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Deploys the mailbox we use to output gamepieces</div>
<div class="block">Creates a new DeployMailbox.</div>
</div>
</div>
</section>
Expand Down Expand Up @@ -145,7 +146,7 @@ <h2>Constructor Details</h2>
<section class="detail" id="&lt;init&gt;()">
<h3>DeployMailbox</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DeployMailbox</span>()</div>
<div class="block">Deploys the mailbox we use to output gamepieces</div>
<div class="block">Creates a new DeployMailbox.</div>
</section>
</li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions javadoc/frc/robot/commands/RunIntake.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ <h1 title="Class RunIntake" class="title">Class RunIntake</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RunIntake</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
<div class="block">Command that runs the intake on the robot.</div>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down
8 changes: 6 additions & 2 deletions javadoc/frc/robot/commands/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ <h1 title="Package frc.robot.commands" class="title">Package frc.robot.commands<
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DeployMailbox.html" title="class in frc.robot.commands">DeployMailbox</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Deploys the mailbox pneumatics and runs the belts; effectively deploys the mailbox on the bot.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DeployPneumatics.html" title="class in frc.robot.commands">DeployPneumatics</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Command that extends the mailbox when started, and lowers the mailbox when ended.</div>
Expand All @@ -103,7 +105,9 @@ <h1 title="Package frc.robot.commands" class="title">Package frc.robot.commands<
<div class="block">Command that activates belts when started, and deactivates belts when ended.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RunIntake.html" title="class in frc.robot.commands">RunIntake</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Command that runs the intake on the robot.</div>
</div>
</div>
</div>
</li>
Expand Down
Loading

0 comments on commit 2f7aee0

Please sign in to comment.