add javadoc style comments to ExpellBall and IntakeBall commands
authorLauren Meier <meier.lauren@gmail.com>
Fri, 12 Feb 2016 04:24:59 +0000 (20:24 -0800)
committerLauren Meier <meier.lauren@gmail.com>
Sat, 13 Feb 2016 22:43:23 +0000 (14:43 -0800)
src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java
src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java

index 19ff62795b78c3c6b9dabb7c397a25cf6fc62509..804ce7ae0a7ecf84ba59bf3bb1c13989ab3cec5d 100644 (file)
@@ -4,6 +4,19 @@ import org.usfirst.frc.team3501.robot.Robot;
 
 import edu.wpi.first.wpilibj.command.Command;
 
+/***
+ * This command will expel a boulder from the robot, if it is even present to
+ * begin with.
+ *
+ * pre-condition: A boulder is present inside the robot.
+ *
+ * post-condition: A boulder is expelled from inside the robot to the field
+ * outside of the robot.
+ *
+ * @author Lauren and Niyati
+ *
+ */
+
 public class ExpelBall extends Command {
 
   public ExpelBall() {
index 37b55bc6c16de67362c6ea0546f7055b3494eea2..c90a08017d5bf010855c45de20aa0f3ced0989a9 100644 (file)
@@ -4,6 +4,19 @@ import org.usfirst.frc.team3501.robot.Robot;
 
 import edu.wpi.first.wpilibj.command.Command;
 
+/***
+ * This command will take a boulder into the robot if there is not a boulder
+ * present inside already.
+ *
+ * pre-condition: A boulder is not present inside the robot.
+ *
+ * post-condition: A boulder is taken in from the field outside of the robot
+ * into the robot.
+ *
+ * @author Lauren and Niyati
+ *
+ */
+
 public class IntakeBall extends Command {
 
   public IntakeBall() {