change method name from getDistance to getAngleForLevel and add javadoc style comment...

diff --git a/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java b/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java
index 3c6309b474d1ca48c33e57a87193972881f7ea18..81365c88a1f4bd85b8b75e64106f199373b5ca85 100755 (executable)
--- a/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java
+++ b/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java
@@ -39,7 +39,18 @@ public class DefenseArm extends Subsystem {
     return defenseHandPotentiometer.get();
   }
 
-  public double getDistance(int desiredArmLocation) {
+  /***
+   * This method takes an arm location as input (range of [0,2])
+   * Returns the angle of the arm corresponding to that arm location
+   *
+   * @param desiredArmLocation
+   *          takes an arm location ranging from [0,2]
+   *          0 is the lowest position of arm
+   *          2 is the highest position of arm
+   * @return
+   *         the angle of the arm corresponding to that arm location
+   */
+  public double getAngleForLocation(int desiredArmLocation) {
     return potAngles[desiredArmLocation];
   }