Add pre-conditions and post-conditions to comments

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

diff --git a/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinch.java b/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinch.java
index d6d047c98f53671e57a77ea9405c0961e0c49a65..54df317ea3d7a88b2b82356db9205b4a2eb279f2 100644 (file)
--- a/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinch.java
+++ b/src/org/usfirst/frc/team3501/robot/commands/climber/RunWinch.java
@@ -7,7 +7,13 @@ import com.sun.glass.ui.Timer;
 import edu.wpi.first.wpilibj.command.Command;
 
 /**
- * This command runs the winch for a given motor value and time in seconds
+ * This command runs the winch at a specified speed and time in seconds when the
+ * button triggering it is pressed.
+ *
+ * pre-condition: This command is run by a button in OI. The robot must be
+ * attached to the rope.
+ *
+ * post-condition: Winch motor set to a specified speed for a specified time.
  *
  * @param motorVal
  *          value range is from -1 to 1