add pre and post conditions for the LiftPortcullis command

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

diff --git a/src/org/usfirst/frc/team3501/robot/commands/LiftPortcullis.java b/src/org/usfirst/frc/team3501/robot/commands/LiftPortcullis.java
index d2405883794740fe33f64609fe11f4349692f3fd..992f9e1ae9e529f965efd583e4431c819b78f7a7 100755 (executable)
--- a/src/org/usfirst/frc/team3501/robot/commands/LiftPortcullis.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/LiftPortcullis.java
@@ -2,29 +2,44 @@ package org.usfirst.frc.team3501.robot.commands;
 
 import edu.wpi.first.wpilibj.command.Command;
 
+/***
+ * This command will move the robot forward while lifting the defense arm up.
+ *
+ * pre-condition: robot is flush against the ramp of the outerworks in front of
+ * the portcullis
+ *
+ * This command has to drive forward at the same time because that's how the
+ * robot opens the portcullis
+ *
+ * post-condition: the robot has passed the portcullis and is in the next zone
+ *
+ * @author Meryem and Avi
+ *
+ */
+
 public class LiftPortcullis extends Command {
 
-       public LiftPortcullis() {
-       }
+  public LiftPortcullis() {
+  }
 
-       @Override
-       protected void initialize() {
-       }
+  @Override
+  protected void initialize() {
+  }
 
-       @Override
-       protected void execute() {
-       }
+  @Override
+  protected void execute() {
+  }
 
-       @Override
-       protected boolean isFinished() {
-               return false;
-       }
+  @Override
+  protected boolean isFinished() {
+    return false;
+  }
 
-       @Override
-       protected void end() {
-       }
+  @Override
+  protected void end() {
+  }
 
-       @Override
-       protected void interrupted() {
-       }
+  @Override
+  protected void interrupted() {
+  }
 }