From d034d78f15b077a823078a3c648546d325734fc6 Mon Sep 17 00:00:00 2001 From: Lauren Meier Date: Thu, 11 Feb 2016 20:24:59 -0800 Subject: [PATCH] add javadoc style comments to ExpellBall and IntakeBall commands --- .../frc/team3501/robot/commands/ExpelBall.java | 13 +++++++++++++ .../frc/team3501/robot/commands/IntakeBall.java | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java b/src/org/usfirst/frc/team3501/robot/commands/ExpelBall.java index 19ff6279..804ce7ae 100644 --- 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() { diff --git a/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java b/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java index 37b55bc6..c90a0801 100644 --- a/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java +++ b/src/org/usfirst/frc/team3501/robot/commands/IntakeBall.java @@ -4,6 +4,19 @@ import org.usfirst.frc.team3501.robot.Robot; import edu.wpi.first.wpilibj.command.Command; +/*** + * This command will take a boulder into the robot if there is not a boulder + * present inside already. + * + * pre-condition: A boulder is not present inside the robot. + * + * post-condition: A boulder is taken in from the field outside of the robot + * into the robot. + * + * @author Lauren and Niyati + * + */ + public class IntakeBall extends Command { public IntakeBall() { -- 2.30.2