Edit JavaDoc comments in shooter commands

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 85543ce6b15aec119ad506e05d356e82886fcd33..cda56a73480f1934b266e727a99aa82ccf312c74 100644 (file)
--- 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 646dc56d41be28562bffee314fdc4c0da8ab1535..13c3eceb18ef4c6d5a698c3311dc02d6ae42de68 100644 (file)
--- 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 5d075313a4b2fe99555325ea4b45544faa2128fd..cac708e4d13b5770b2b1e9b7a150e215a586c47d 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,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 f4b06930b6e13a755b489df95c0f9f99d053ac30..04dc4a6e5747e765db89f6a764d4ed6166052de4 100644 (file)
--- 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 633154fc1ef9cafe283d4cdbe850fe88f51cfdcb..01eba1988adb89ed021b52b911177df0cfeb2a1d 100644 (file)
--- 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 0af49297928e8f7d674da212d294c09e65d90d84..f58e246b6a609a0b1a75ffa6141d8388e0481a03 100644 (file)
--- 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;
+  }
 
 }