projects
/
3501
/
2017steamworks
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
de8c65d
)
Add pre-conditions and post-conditions to comments
author
Shivani Ghanta
<shivani.oghanta@gmail.com>
Wed, 18 Jan 2017 03:10:14 +0000
(19:10 -0800)
committer
Shivani Ghanta
<shivani.oghanta@gmail.com>
Sat, 21 Jan 2017 22:27:37 +0000
(14:27 -0800)
src/org/usfirst/frc/team3501/robot/commands/climber/RunWinch.java
patch
|
blob
|
blame
|
history
src/org/usfirst/frc/team3501/robot/commands/climber/RunWinchContinuous.java
patch
|
blob
|
blame
|
history
src/org/usfirst/frc/team3501/robot/commands/climber/StopWinch.java
patch
|
blob
|
blame
|
history
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;
/**
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
*
* @param motorVal
* value range is from -1 to 1
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
/**
* 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
*
*
* @author shivanighanta
*
diff --git
a/src/org/usfirst/frc/team3501/robot/commands/climber/StopWinch.java
b/src/org/usfirst/frc/team3501/robot/commands/climber/StopWinch.java
index 8fa01a3014876d16872927b7ada95fa46fa5ed87..903f22b94488c57bb6bdee942894ef6f4b40e084 100644
(file)
--- a/
src/org/usfirst/frc/team3501/robot/commands/climber/StopWinch.java
+++ b/
src/org/usfirst/frc/team3501/robot/commands/climber/StopWinch.java
@@
-5,7
+5,9
@@
import org.usfirst.frc.team3501.robot.Robot;
import edu.wpi.first.wpilibj.command.Command;
/**
import edu.wpi.first.wpilibj.command.Command;
/**
- * Stops the winch
+ * This command stops the winch
+ *
+ * post-condition: the motor values are set to 0.
*
* @author shivanighanta
*
*
* @author shivanighanta
*