add javadoc style comments to ExpellBall and IntakeBall commands

[3501/stronghold-2016] / src / org / usfirst / frc / team3501 / robot / commands / IntakeBall.java

diff --git a/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java b/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java
index 37b55bc6c16de67362c6ea0546f7055b3494eea2..c90a08017d5bf010855c45de20aa0f3ced0989a9 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java
@@ -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() {