From 7e57cf8f2d2115551c6bd6d3a332c733e3512db4 Mon Sep 17 00:00:00 2001 From: "Keenan D. Buckley" Date: Sun, 5 Jan 2020 20:27:01 -0700 Subject: [PATCH] Added "Add your docs here" flags to all needed methods - All methods that need javadoc have been marked with /** * Add your docs here. */ --- src/main/java/frc4388/robot/RobotContainer.java | 13 ++++++++++++- .../frc4388/robot/commands/LED/SetLEDPattern.java | 3 +++ src/main/java/frc4388/robot/subsystems/Drive.java | 6 ++++++ src/main/java/frc4388/robot/subsystems/LED.java | 9 +++++++++ .../frc4388/utility/controller/IHandController.java | 3 +++ .../frc4388/utility/controller/XboxController.java | 6 ++++++ 6 files changed, 39 insertions(+), 1 deletion(-) diff --git a/src/main/java/frc4388/robot/RobotContainer.java b/src/main/java/frc4388/robot/RobotContainer.java index 9ba1572..e3702f4 100644 --- a/src/main/java/frc4388/robot/RobotContainer.java +++ b/src/main/java/frc4388/robot/RobotContainer.java @@ -69,21 +69,32 @@ public class RobotContainer { return new InstantCommand(); } - + /** + * Add your docs here. + */ public IHandController getDriverController() { return m_driverXbox; } + /** + * Add your docs here. + */ public IHandController getOperatorController() { return m_operatorXbox; } + /** + * Add your docs here. + */ public Joystick getOperatorJoystick() { return m_operatorXbox.getJoyStick(); } + /** + * Add your docs here. + */ public Joystick getDriverJoystick() { return m_driverXbox.getJoyStick(); diff --git a/src/main/java/frc4388/robot/commands/LED/SetLEDPattern.java b/src/main/java/frc4388/robot/commands/LED/SetLEDPattern.java index 088a75d..a7e793e 100644 --- a/src/main/java/frc4388/robot/commands/LED/SetLEDPattern.java +++ b/src/main/java/frc4388/robot/commands/LED/SetLEDPattern.java @@ -20,6 +20,9 @@ public class SetLEDPattern extends InstantCommand { private final LED m_led; public static LEDPatterns m_pattern; + /** + * Add your docs here. + */ public SetLEDPattern(LED subsystem, LEDPatterns pattern) { m_led = subsystem; m_pattern = pattern; diff --git a/src/main/java/frc4388/robot/subsystems/Drive.java b/src/main/java/frc4388/robot/subsystems/Drive.java index b5edc2f..d39260f 100644 --- a/src/main/java/frc4388/robot/subsystems/Drive.java +++ b/src/main/java/frc4388/robot/subsystems/Drive.java @@ -30,6 +30,9 @@ public class Drive extends SubsystemBase { public static DifferentialDrive m_driveTrain = new DifferentialDrive(m_leftFrontMotor, m_rightFrontMotor); + /** + * Add your docs here. + */ public Drive(){ /* factory default values */ m_leftFrontMotor.configFactoryDefault(); @@ -54,6 +57,9 @@ public class Drive extends SubsystemBase { m_rightBackMotor.setInverted(InvertType.FollowMaster); } + /** + * Add your docs here. + */ public void driveWithInput(double move, double steer){ m_driveTrain.arcadeDrive(move, steer); } diff --git a/src/main/java/frc4388/robot/subsystems/LED.java b/src/main/java/frc4388/robot/subsystems/LED.java index 02c61ba..daf5751 100644 --- a/src/main/java/frc4388/robot/subsystems/LED.java +++ b/src/main/java/frc4388/robot/subsystems/LED.java @@ -23,6 +23,9 @@ public class LED extends SubsystemBase { public static float currentLED; public static Spark LEDController; + /** + * Add your docs here. + */ public LED(){ LEDController = new Spark(LEDConstants.LED_SPARK_ID); setPattern(LEDPatterns.FOREST_WAVES); @@ -30,10 +33,16 @@ public class LED extends SubsystemBase { System.err.println("In the Beginning, there was Joe.\nAnd he said, 'Let there be LEDs.'\nAnd it was good."); } + /** + * Add your docs here. + */ public void updateLED(){ LEDController.set(currentLED); } + /** + * Add your docs here. + */ public void setPattern(LEDPatterns pattern){ currentLED = pattern.getValue(); LEDController.set(currentLED); diff --git a/src/main/java/frc4388/utility/controller/IHandController.java b/src/main/java/frc4388/utility/controller/IHandController.java index 40ba864..13aa763 100644 --- a/src/main/java/frc4388/utility/controller/IHandController.java +++ b/src/main/java/frc4388/utility/controller/IHandController.java @@ -1,5 +1,8 @@ package frc4388.utility.controller; +/** + * Add your docs here. + */ public interface IHandController { public double getLeftXAxis(); diff --git a/src/main/java/frc4388/utility/controller/XboxController.java b/src/main/java/frc4388/utility/controller/XboxController.java index 83dcaf4..8b8f0f8 100644 --- a/src/main/java/frc4388/utility/controller/XboxController.java +++ b/src/main/java/frc4388/utility/controller/XboxController.java @@ -52,10 +52,16 @@ public class XboxController implements IHandController private Joystick m_stick; + /** + * Add your docs here. + */ public XboxController(int portNumber){ m_stick = new Joystick(portNumber); } + /** + * Add your docs here. + */ public Joystick getJoyStick() { return m_stick; }