Merge pull request #44 from frc937/javadoooooooooc

javadoc

src/main/java/frc/robot/Constants.java

@@ -52,6 +52,7 @@ public static class Controllers {
     public static final int DRIVER_CONTROLLER_PORT = 0;
   }
 
+  /** Constants for the Drivetrain */
   public static class Drive {
     /** Empty translation to prevent creating 2 Translation2ds every time the drive train stops. */
     public static Translation2d EMPTY_TRANSLATION = new Translation2d();
@@ -63,6 +64,7 @@ public static class Drive {
     public static double MAX_ANGULAR_SPEED = Math.PI / 2;
   }
 
+  /** Constants for the Intake System */
   public static class Intake {
     /** Motor id of the Intake motor. */
     public static final int INTAKE_MOTOR_ID = 0;

src/main/java/frc/robot/subsystems/Intake.java

@@ -36,8 +36,11 @@ public void runIntake() {
 
   /**
    * Returns a boolean value on whether or not the Limit Switch (for the intake) has been activated.
+   *
+   * @return the status of the limit switch
    */
   public boolean getLimitSwitch() {
+    /* Assumes the limit switch is wired to be normally open. */
     return limitSwitch.get();
   }
 

src/main/java/frc/robot/subsystems/UrMom.java

@@ -18,6 +18,7 @@ public class UrMom extends SubsystemBase {
   /** Creates a new UrMom. */
   public UrMom() {}
 
+  /** Does what you think it does. */
   public void printUrMom() {
     System.out.println("your mom");
   }