Add JavaDoc comments
authorArunima DIvya <adivya822@student.fuhsd.org>
Tue, 24 Jan 2017 05:08:33 +0000 (21:08 -0800)
committerArunima DIvya <adivya822@student.fuhsd.org>
Thu, 26 Jan 2017 04:14:06 +0000 (20:14 -0800)
src/org/usfirst/frc/team3501/robot/subsystems/Intake.java

index b5e72053c3f90aba576e89913960873b31b99d2b..15a82a0061eb2bb321eb9ab86b4927c9d777b478 100644 (file)
@@ -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);
   }