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 161f7b6b68a344f60cb69b7fa67a36e57671fcb2..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,13 +3,15 @@ package org.usfirst.frc.team3501.robot.commands.shooter;
 import edu.wpi.first.wpilibj.command.Command;
 
 /**
- * Runs index wheel continuously when corresponding button is pressed
+ * This command will run the index wheel motor continuously until the button
+ * triggering it is released.
  *
- * Run stopIndexWheel to stop
+ * pre-condition: This command must be run by a button in OI with
+ * button.whileHeld(...).
  *
  * @param motorVal
- *          [-1,1]
- * @author shaina
+ *          value range is from -1 to 1
+ * @author Shaina
  */
 public class RunIndexWheelContinuous extends Command {
   private double motorVal;