Add javadoc comments to command class constructors

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

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 5d075313a4b2fe99555325ea4b45544faa2128fd..58a59fbdd8e9669a534703caa1d59b9313ff5b8b 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/shooter/RunIndexWheel.java
@@ -3,18 +3,25 @@ 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.
  *
- * @param motorVal
- *          [-1,1]
- * @param time
- *          in seconds
- * @author shaina
+ * pre-condition: fly wheel is running at full speed to prepare for shooting
+ * fuel
+ *
+ * @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;