Deploying to javadoc from @ 537f290 🚀

frc937 · Feb 1, 2024 · 7c2101b · 7c2101b
1 parent 2f7aee0
commit 7c2101b
Show file tree

Hide file tree

Showing 17 changed files with 565 additions and 101 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -87,49 +87,54 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <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/DriveFieldOriented.html" title="class in frc.robot.commands">DriveFieldOriented</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/drive/DriveFieldOriented.html" title="class in frc.robot.commands.drive">DriveFieldOriented</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <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/DriveRobotOriented.html" title="class in frc.robot.commands">DriveRobotOriented</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/drive/DriveFieldOrientedHeadingSnapping.html" title="class in frc.robot.commands.drive">DriveFieldOrientedHeadingSnapping</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 class="block">Drives robot in field oriented mode with shortcuts to snap to field relative angles in increments
+ of 90º using dpad</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-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/drive/DriveRobotOriented.html" title="class in frc.robot.commands.drive">DriveRobotOriented</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 class="block">Drives the robot in robot-oriented mode.</div>
 </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-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-last even-row-color all-classes-table all-classes-table-tab2">
-<div class="block">The intake of the robot.</div>
+<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/subsystems/mailbox/Mailbox.html" title="class in frc.robot.subsystems.mailbox">Mailbox</a></div>
+<div class="col-first odd-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 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 class="block">The intake of the 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-first even-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 even-row-color all-classes-table all-classes-table-tab2">
-<div class="block">Subsystem for the mailbox belt.</div>
+<div class="block">Subsystem for the mailbox that outputs game pieces from our robot.</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-first odd-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 odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Subsystem for the mailbox belt.</div>
+</div>
+<div class="col-first even-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 even-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-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/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="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-last odd-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="col-first even-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 even-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">
+<div class="col-first odd-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 odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Command that runs the intake on the robot.</div>
 </div>
 </div>

diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -57,10 +57,12 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><a href="frc/robot/commands/package-summary.html">frc.robot.commands</a></div>
 <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-first even-row-color"><a href="frc/robot/commands/drive/package-summary.html">frc.robot.commands.drive</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-first odd-row-color"><a href="frc/robot/subsystems/package-summary.html">frc.robot.subsystems</a></div>
 <div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="frc/robot/subsystems/mailbox/package-summary.html">frc.robot.subsystems.mailbox</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
 </div>
 </main>
 </div>

diff --git a/javadoc/element-list b/javadoc/element-list
@@ -1,4 +1,5 @@
 frc.robot
 frc.robot.commands
+frc.robot.commands.drive
 frc.robot.subsystems
 frc.robot.subsystems.mailbox
diff --git a/...rc/robot/commands/DriveFieldOriented.html → ...ot/commands/drive/DriveFieldOriented.html b/...rc/robot/commands/DriveFieldOriented.html → ...ot/commands/drive/DriveFieldOriented.html
@@ -5,21 +5,21 @@
 <title>DriveFieldOriented (robot2024 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="description" content="declaration: package: frc.robot.commands, class: DriveFieldOriented">
+<meta name="description" content="declaration: package: frc.robot.commands.drive, class: DriveFieldOriented">
 <meta name="generator" content="javadoc/ClassWriterImpl">
-<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
-<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
-<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
-<script type="text/javascript" src="../../../script.js"></script>
-<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
-<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="../../../../script.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
-var pathtoroot = "../../../";
+var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
@@ -31,12 +31,12 @@
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="../../../index.html">Overview</a></li>
+<li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
-<li><a href="../../../index-all.html">Index</a></li>
-<li><a href="../../../help-doc.html#class">Help</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
@@ -67,12 +67,12 @@
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
-<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">frc.robot.commands</a></div>
+<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">frc.robot.commands.drive</a></div>
 <h1 title="Class DriveFieldOriented" class="title">Class DriveFieldOriented</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">edu.wpi.first.wpilibj2.command.Command
-<div class="inheritance">frc.robot.commands.DriveFieldOriented</div>
+<div class="inheritance">frc.robot.commands.drive.DriveFieldOriented</div>
 </div>
 </div>
 <section class="class-description" id="class-description">