Edit JavaDoc comments in shooter commands

[3501/2017steamworks] / src / org / usfirst / frc / team3501 / robot / commands / shooter / RunIndexWheelContinuous.java

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 cd3b1d4f4fbd1f409e2ed38668442291f3f8c6c5..97e8d22f2cc5ce633c59d70f5a430e2ea2d0919d 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheelContinuous.java
@@ -3,38 +3,47 @@ package org.usfirst.frc.team3501.robot.commands.shooter;
 import edu.wpi.first.wpilibj.command.Command;
 
 /**
- * Runs index wheel continuously until ________
+ * 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 with
+ * button.whileHeld(...).
+ *
+ * @param motorVal
+ *          value range is from -1 to 1
+ * @author Shaina
  */
 public class RunIndexWheelContinuous extends Command {
-       public RunIndexWheelContinuous() {
-
-       }
-
-       // 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;
-       }
+  private double motorVal;
+
+  public RunIndexWheelContinuous(double motorVal) {
+    this.motorVal = motorVal;
+  }
+
+  // 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() {
+    return false;
+  }
 
 }