From 66b47d2ca76bec93ec081cb8658c09c6a7b906a8 Mon Sep 17 00:00:00 2001 From: Arunima DIvya Date: Mon, 23 Jan 2017 21:08:33 -0800 Subject: [PATCH] Add JavaDoc comments --- .../frc/team3501/robot/subsystems/Intake.java | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/org/usfirst/frc/team3501/robot/subsystems/Intake.java b/src/org/usfirst/frc/team3501/robot/subsystems/Intake.java index b5e7205..15a82a0 100644 --- a/src/org/usfirst/frc/team3501/robot/subsystems/Intake.java +++ b/src/org/usfirst/frc/team3501/robot/subsystems/Intake.java @@ -7,6 +7,8 @@ import com.ctre.CANTalon; import edu.wpi.first.wpilibj.command.Subsystem; /** + * Intakes the balls into ball container. + * * @author Meeta */ public class Intake extends Subsystem { @@ -14,11 +16,16 @@ public class Intake extends Subsystem { private CANTalon intakeWheel; public static final double INTAKE_SPEED = 0; - // create speed of intake whee public Intake() { intakeWheel = new CANTalon(Constants.Intake.INTAKE_ROLLER_PORT); } + /*** + * It gets the intake instance, and if intake has not been initialized, then + * it will be initialized. + * + * @returns intake + */ public static Intake getIntake() { if (intake == null) { intake = new Intake(); @@ -31,6 +38,12 @@ public class Intake extends Subsystem { } + /*** + * Sets speed of intake wheel to input speed + * + * @param speed + * from -1 to 1 + */ public void setSpeed(double speed) { intakeWheel.set(speed); } -- 2.30.2