Fix javadoc for the suppliers

frc937 · Feb 20, 2024 · d81197e · d81197e
1 parent baf54b9
commit d81197e
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/src/main/java/frc/robot/commands/drive/DriveFieldOriented.java b/src/main/java/frc/robot/commands/drive/DriveFieldOriented.java
@@ -26,9 +26,9 @@ public class DriveFieldOriented extends Command {
   /**
    * Drives the robot field-oriented
    *
-   * @param xSupplier The x speed
-   * @param ySupplier The y speed
-   * @param zSupplier The z speed
+   * @param xSupplier The joystick value for the Y axis. [-1, 1] left positive.
+   * @param ySupplier The joystick value for the Y axis. [-1, 1] back positive.
+   * @param zSupplier The joystick value for the Z axis. [-1, 1] counterclockwise positive.
    */
   public DriveFieldOriented(
       Supplier<Double> xSupplier, Supplier<Double> ySupplier, Supplier<Double> zSupplier) {

diff --git a/src/main/java/frc/robot/commands/drive/DriveFieldOrientedHeadingSnapping.java b/src/main/java/frc/robot/commands/drive/DriveFieldOrientedHeadingSnapping.java
@@ -35,13 +35,14 @@ public class DriveFieldOrientedHeadingSnapping extends Command {
    * Drives the robot field oriented with heading snapping. All values are suppliers to make the
    * command more versatile.
    *
-   * @param xSupplier The x speed
-   * @param ySupplier The y speed
-   * @param zSupplier The z speed
-   * @param upSupplier If the robot should go up
-   * @param downSupplier If the robot should go down
-   * @param leftSupplier If the robot should go left
-   * @param rightSupplier If the robot should go right
+   * @param xSupplier The joystick value for the Y axis. [-1, 1] left positive.
+   * @param ySupplier The joystick value for the Y axis. [-1, 1] back positive.
+   * @param zSupplier The joystick value for the Z axis. [-1, 1] counterclockwise positive.
+   * @param upSupplier If true, the robot heading will be set to move towards the opposing alliance
+   *     wall
+   * @param downSupplier If true, the robot heading will be set to move towards our alliance wall
+   * @param leftSupplier If true, the robot heading will be set to move towards the left
+   * @param rightSupplier If true, the robot heading will be set to move towards the right
    */
   public DriveFieldOrientedHeadingSnapping(
       Supplier<Double> xSupplier,

diff --git a/src/main/java/frc/robot/commands/drive/DriveRobotOriented.java b/src/main/java/frc/robot/commands/drive/DriveRobotOriented.java
@@ -26,9 +26,9 @@ public class DriveRobotOriented extends Command {
   /**
    * Drives the robot robot-oriented
    *
-   * @param xSupplier The x speed
-   * @param ySupplier The y speed
-   * @param zSupplier The z speed
+   * @param xSupplier The joystick value for the Y axis. [-1, 1] left positive.
+   * @param ySupplier The joystick value for the Y axis. [-1, 1] back positive.
+   * @param zSupplier The joystick value for the Z axis. [-1, 1] counterclockwise positive.
    */
   public DriveRobotOriented(
       Supplier<Double> xSupplier, Supplier<Double> ySupplier, Supplier<Double> zSupplier) {