Add javadoc comments to command class constructors

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 b3784bb94e1d2f6b955028566aae7419a619a3ce..f57cd5bc607865b133f1e18ec786cc796a5075cc 100644 (file)
--- 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 20a4d08f37cf6c608a911acc9c722d597b42a759..65a69f232dd8d6fd5f7699b261a093235434edea 100644 (file)
--- 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 6804c255b781c67c0609f9615a9eb6e921f61274..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
@@ -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 97e8d22f2cc5ce633c59d70f5a430e2ea2d0919d..6f306f85e97bea7f37474f4770753b2a35affade 100644 (file)
--- 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 ac7ea5cb49112496d93b550b870069fda89d6c0a..53fc35c5ea543e80b04f9caf16baefa020fa51d1 100644 (file)
--- 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 eafdb5822237c76ca67a019be542a1891ad43032..4a04f4caacf2dee9816ca7b791dd9ff41e9aba12 100644 (file)
--- 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() {
 
   }