From b7ef589aaceec01ee3478523108784569f664be5 Mon Sep 17 00:00:00 2001 From: shainachen Date: Sat, 21 Jan 2017 11:22:40 -0800 Subject: [PATCH] Add javadoc comments to command class constructors --- .../team3501/robot/commands/shooter/RunFlyWheel.java | 12 ++++++++---- .../commands/shooter/RunFlyWheelContinuous.java | 8 ++++++-- .../robot/commands/shooter/RunIndexWheel.java | 12 ++++++++---- .../commands/shooter/RunIndexWheelContinuous.java | 8 ++++++-- .../robot/commands/shooter/StopFlyWheel.java | 5 ++++- .../robot/commands/shooter/StopIndexWheel.java | 3 +++ 6 files changed, 35 insertions(+), 13 deletions(-) diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java index b3784bb..f57cd5b 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java @@ -6,16 +6,20 @@ import edu.wpi.first.wpilibj.command.Command; * This command runs the fly wheel at a given speed for a given time. The fly * wheel is intended to shoot balls fed by the intake wheel. * - * @param motorVal - * value range from -1 to 1 - * @param time - * in seconds * @author Shaina */ public class RunFlyWheel extends Command { private double motorVal; private double time; + /** + * See JavaDoc comment in class for details + * + * @param motorVal + * value range from -1 to 1 + * @param time + * in seconds, amount of time to run fly wheel motor + */ public RunFlyWheel(double motorVal, double time) { this.motorVal = motorVal; this.time = time; diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java index 20a4d08..65a69f2 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java @@ -9,13 +9,17 @@ import edu.wpi.first.wpilibj.command.Command; * pre-condition: This command must be run by a button in OI, with * button.whileHeld(...). * - * @param motorVal - * value range from -1 to 1 * @author Shaina */ public class RunFlyWheelContinuous extends Command { private double motorVal; + /** + * See JavaDoc comment in class for details + * + * @param motorVal + * value range from -1 to 1 + */ public RunFlyWheelContinuous(double motorVal) { this.motorVal = motorVal; } diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java index 6804c25..58a59fb 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java @@ -8,16 +8,20 @@ import edu.wpi.first.wpilibj.command.Command; * pre-condition: fly wheel is running at full speed to prepare for shooting * fuel * - * @param motorVal - * value range is from -1 to 1 - * @param time - * in seconds * @author Shaina */ public class RunIndexWheel extends Command { private double time; private double motorVal; + /** + * See JavaDoc comment in class for details + * + * @param motorVal + * value range from -1 to 1 + * @param time + * in seconds, amount of time to run index wheel motor + */ public RunIndexWheel(double motorVal, double time) { this.motorVal = motorVal; this.time = time; diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java index 97e8d22..6f306f8 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java @@ -9,13 +9,17 @@ import edu.wpi.first.wpilibj.command.Command; * pre-condition: This command must be run by a button in OI with * button.whileHeld(...). * - * @param motorVal - * value range is from -1 to 1 * @author Shaina */ public class RunIndexWheelContinuous extends Command { private double motorVal; + /** + * See JavaDoc comment in class for details + * + * @param motorVal + * value range from -1 to 1 + */ public RunIndexWheelContinuous(double motorVal) { this.motorVal = motorVal; } diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java index ac7ea5c..53fc35c 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java @@ -6,10 +6,13 @@ import edu.wpi.first.wpilibj.command.Command; * This command stops the fly wheel. Do not call unless the trigger button has * been released. * - * + * * @author Shaina */ public class StopFlyWheel extends Command { + /** + * This command stops the fly wheel. + */ public StopFlyWheel() { } diff --git a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java index eafdb58..4a04f4c 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java @@ -9,6 +9,9 @@ import edu.wpi.first.wpilibj.command.Command; * @author Shaina */ public class StopIndexWheel extends Command { + /** + * This command stops the index wheel. + */ public StopIndexWheel() { } -- 2.30.2