Merge pull request #71 from frc937/auto-drive-javadoc

Add the doc of the java variety to auto drive commands
frc937 · Feb 20, 2024 · 6a52f55 · 6a52f55
2 parents 743ee72 + 62b10d8
commit 6a52f55
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/src/main/java/frc/robot/commands/auto/DriveAutoFieldOriented.java b/src/main/java/frc/robot/commands/auto/DriveAutoFieldOriented.java
@@ -16,16 +16,22 @@
 import frc.robot.RobotContainer;
 import frc.robot.subsystems.Drive;
 
+/** Drives the robot field oriented autonomously. */
 public class DriveAutoFieldOriented extends Command {
   private Drive drive;
   private Translation2d destination;
   private double rotation;
 
-  /** Creates a new DriveAuto. */
-  public DriveAutoFieldOriented(Translation2d destination, double rotation) {
+  /**
+   * Creates a new DriveAutoFieldOriented.
+   *
+   * @param translation The velocities for the robot to drive while the command is running
+   * @param rotation The rotation velocity of the robot while the command is running.
+   */
+  public DriveAutoFieldOriented(Translation2d translation, double rotation) {
     this.drive = RobotContainer.drive;
     addRequirements(this.drive);
-    this.destination = destination;
+    this.destination = translation;
     this.rotation = rotation;
     // Use addRequirements() here to declare subsystem dependencies.
   }

diff --git a/src/main/java/frc/robot/commands/auto/DriveAutoRobotOriented.java b/src/main/java/frc/robot/commands/auto/DriveAutoRobotOriented.java
@@ -16,16 +16,22 @@
 import frc.robot.RobotContainer;
 import frc.robot.subsystems.Drive;
 
+/** Drives the robot field robot autonomously. */
 public class DriveAutoRobotOriented extends Command {
   private Drive drive;
   private Translation2d destination;
   private double rotation;
 
-  /** Creates a new DriveAuto. */
-  public DriveAutoRobotOriented(Translation2d destination, double rotation) {
+  /**
+   * Creates a new DriveAutoRobotOriented.
+   *
+   * @param translation The velocities for the robot to drive while the command is running
+   * @param rotation The rotation velocity of the robot while the command is running.
+   */
+  public DriveAutoRobotOriented(Translation2d translation, double rotation) {
     this.drive = RobotContainer.drive;
     addRequirements(this.drive);
-    this.destination = destination;
+    this.destination = translation;
     this.rotation = rotation;
     // Use addRequirements() here to declare subsystem dependencies.
   }