Add pre-conditions and post-conditions to comments

[3501/2017steamworks] / src / org / usfirst / frc / team3501 / robot / commands / climber / RunWinchContinuous.java

diff --git a/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinchContinuous.java b/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinchContinuous.java
index c15ca1047c16f1697cebfca04fc0abaf7432c89d..bb2a74e8398aeefc7a2a104a01822af6197b1967 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinchContinuous.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinchContinuous.java
@@ -6,7 +6,15 @@ import edu.wpi.first.wpilibj.command.Command;
 
 /**
  * This command will run the winch motor continuously until the button
- * triggering it is released
+ * triggering it is released.
+ *
+ * pre-condition: This command must be run by a button in OI. The robot must be
+ * attached to the rope.
+ *
+ * post-condition: Winch motor set to a specified speed.
+ *
+ * @param motorVal
+ *          value range is from -1 to 1
  *
  * @author shivanighanta
  *