add javadoc style comments to ExpellBall and IntakeBall commands

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

diff --git a/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java b/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java
index 19ff62795b78c3c6b9dabb7c397a25cf6fc62509..804ce7ae0a7ecf84ba59bf3bb1c13989ab3cec5d 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java
@@ -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() {