From 973f0ac4729612ff4ed04086793e5513579c2496 Mon Sep 17 00:00:00 2001 From: shainachen Date: Mon, 16 Jan 2017 19:54:58 -0800 Subject: [PATCH] Edit JavaDoc comments in shooter commands --- .../robot/commands/shooter/RunFlyWheel.java | 5 +- .../shooter/RunFlyWheelContinuous.java | 5 +- .../robot/commands/shooter/RunIndexWheel.java | 6 +- .../shooter/RunIndexWheelContinuous.java | 5 +- .../robot/commands/shooter/StopFlyWheel.java | 64 ++++++++++--------- .../commands/shooter/StopIndexWheel.java | 64 ++++++++++--------- 6 files changed, 80 insertions(+), 69 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 85543ce..cda56a7 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheel.java @@ -3,13 +3,14 @@ package org.usfirst.frc.team3501.robot.commands.shooter; import edu.wpi.first.wpilibj.command.Command; /** - * Runs the fly wheel at a given speed for a given time (sec) + * 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 * [-1,1] * @param time * in seconds - * @author shaina + * @author Shaina */ public class RunFlyWheel extends Command { private double motorVal; 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 646dc56..13c3ece 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunFlyWheelContinuous.java @@ -6,11 +6,12 @@ import edu.wpi.first.wpilibj.command.Command; * This command will run the fly wheel motor continuously until the button * triggering it is released. * - * pre-condition: This command must be run by a button in OI. + * pre-condition: This command must be run by a button in OI, with + * button.whileHeld(...). * * @param motorVal * [-1,1] - * @author shaina + * @author Shaina */ public class RunFlyWheelContinuous extends Command { private double 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 5d07531..cac708e 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java @@ -3,7 +3,11 @@ package org.usfirst.frc.team3501.robot.commands.shooter; import edu.wpi.first.wpilibj.command.Command; /** - * Runs index wheel at a given speed for given time in seconds + * This command runs index wheel at a given speed for given time in seconds. + * + * pre-condition: fly wheel is running at full speed to prepare for shooting + * fuel + * * * @param motorVal * [-1,1] 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 f4b0693..04dc4a6 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java @@ -6,8 +6,9 @@ import edu.wpi.first.wpilibj.command.Command; * This command will run the index wheel motor continuously until the button * triggering it is released. * - * pre-condition: This command must be run by a button in OI. - * + * pre-condition: This command must be run by a button in OI with + * button.whileHeld(...). + * * @param motorVal * [-1,1] * @author shaina 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 633154f..01eba19 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopFlyWheel.java @@ -3,38 +3,40 @@ package org.usfirst.frc.team3501.robot.commands.shooter; import edu.wpi.first.wpilibj.command.Command; /** - * Stops fly wheel + * This command stops the fly wheel. + * + * @author Shaina */ public class StopFlyWheel extends Command { - public StopFlyWheel() { - - } - - // Called just before this Command runs the first time - @Override - protected void initialize() { - } - - // Called repeatedly when this Command is scheduled to run - @Override - protected void execute() { - } - - // Called once after isFinished returns true - @Override - protected void end() { - } - - // Called when another command which requires one or more of the same - // subsystems is scheduled to run - @Override - protected void interrupted() { - } - - @Override - protected boolean isFinished() { - // TODO Auto-generated method stub - return false; - } + public StopFlyWheel() { + + } + + // Called just before this Command runs the first time + @Override + protected void initialize() { + } + + // Called repeatedly when this Command is scheduled to run + @Override + protected void execute() { + } + + // Called once after isFinished returns true + @Override + protected void end() { + } + + // Called when another command which requires one or more of the same + // subsystems is scheduled to run + @Override + protected void interrupted() { + } + + @Override + protected boolean isFinished() { + // TODO Auto-generated method stub + return false; + } } 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 0af4929..f58e246 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java +++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/StopIndexWheel.java @@ -3,38 +3,40 @@ package org.usfirst.frc.team3501.robot.commands.shooter; import edu.wpi.first.wpilibj.command.Command; /** - * Stops index wheel + * This command stops the index wheel. + * + * @author Shaina */ public class StopIndexWheel extends Command { - public StopIndexWheel() { - - } - - // Called just before this Command runs the first time - @Override - protected void initialize() { - } - - // Called repeatedly when this Command is scheduled to run - @Override - protected void execute() { - } - - // Called once after isFinished returns true - @Override - protected void end() { - } - - // Called when another command which requires one or more of the same - // subsystems is scheduled to run - @Override - protected void interrupted() { - } - - @Override - protected boolean isFinished() { - // TODO Auto-generated method stub - return false; - } + public StopIndexWheel() { + + } + + // Called just before this Command runs the first time + @Override + protected void initialize() { + } + + // Called repeatedly when this Command is scheduled to run + @Override + protected void execute() { + } + + // Called once after isFinished returns true + @Override + protected void end() { + } + + // Called when another command which requires one or more of the same + // subsystems is scheduled to run + @Override + protected void interrupted() { + } + + @Override + protected boolean isFinished() { + // TODO Auto-generated method stub + return false; + } } -- 2.30.2