fix javadoc warnings/errors

Change-Id: I079699631185f986952bbf4cbb23661f9f9d123d

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/MotorEncoderTest.java

@@ -144,7 +144,7 @@ public class MotorEncoderTest extends AbstractComsSetup {
   }
 
   /**
-   * Tests to see if you set the speed to something not <= 1.0 if the code
+   * Tests to see if you set the speed to something not {@literal <=} 1.0 if the code
    * appropriately throttles the value
    */
   @Test
@@ -155,7 +155,7 @@ public class MotorEncoderTest extends AbstractComsSetup {
   }
 
   /**
-   * Tests to see if you set the speed to something not >= -1.0 if the code
+   * Tests to see if you set the speed to something not {@literal >=} -1.0 if the code
    * appropriately throttles the value
    */
   @Test

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/can/package-info.java

@@ -3,7 +3,7 @@
  * modes and with each supported positional input. Different setup parameters
  * are provided in each Test class. All test classes that want to take advantage
  * of the default test setup frameworks in place should extend
- * {@link AbstractCANTest}
+ * {@link edu.wpi.first.wpilibj.can.AbstractCANTest AbstractCANTest}
  *$
  */
 package edu.wpi.first.wpilibj.can;

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/AnalogCrossConnectFixture.java

@@ -70,7 +70,7 @@ public abstract class AnalogCrossConnectFixture implements ITestFixture {
   }
 
   /**
-   * @return
+   * @return Analog Output
    */
   final public AnalogOutput getOutput() {
     initialize();

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/fixtures/MotorEncoderFixture.java

@@ -51,7 +51,7 @@ public abstract class MotorEncoderFixture<T extends SpeedController> implements
    * Constructor should only be called from outside this class if the Speed
    * controller is not also an implementation of PWM interface
    *$
-   * @return
+   * @return SpeedController
    */
   abstract protected T giveSpeedController();
 
@@ -59,7 +59,7 @@ public abstract class MotorEncoderFixture<T extends SpeedController> implements
    * Where the implementer of this class should pass one of the digital inputs<br>
    * CONSTRUCTOR SHOULD NOT BE CALLED FROM OUTSIDE THIS CLASS!
    *$
-   * @return
+   * @return DigitalInput
    */
   abstract protected DigitalInput giveDigitalInputA();
 

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/mockhardware/FakeCounterSource.java

@@ -10,7 +10,7 @@ import edu.wpi.first.wpilibj.DigitalOutput;
 import edu.wpi.first.wpilibj.Timer;
 
 /**
- * @file FakeCounterSource.java Simulates an encoder for testing purposes
+ * Simulates an encoder for testing purposes
  * @author Ryan O'Meara
  */
 public class FakeCounterSource {

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/mockhardware/FakeEncoderSource.java

@@ -10,7 +10,7 @@ import edu.wpi.first.wpilibj.DigitalOutput;
 import edu.wpi.first.wpilibj.Timer;
 
 /**
- * @file FakeEncoderSource.java Emulates a quadrature encoder
+ * Emulates a quadrature encoder
  * @author Ryan O'Meara
  */
 public class FakeEncoderSource {

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/mockhardware/FakePotentiometerSource.java

@@ -64,7 +64,7 @@ public class FakePotentiometerSource {
   /**
    * Returns the currently set angle
    *$
-   * @return
+   * @return the current angle
    */
   public double getAngle() {
     double voltage = output.getVoltage();

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/mocks/MockCommand.java

@@ -75,7 +75,7 @@ public class MockCommand extends Command {
   }
 
   /**
-   * @param set what value the isFinished method will return
+   * @param hasFinished set what value the isFinished method will return
    */
   public void setHasFinished(boolean hasFinished) {
     this.hasFinished = hasFinished;

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/AbstractTestSuite.java

@@ -38,6 +38,8 @@ public abstract class AbstractTestSuite {
    *$
    * @return the list of classes listed in the
    *         <code>@SuiteClasses({TestClass1.class, ...})</code> annotation.
+   * @throws RuntimeException If the <code>@SuiteClasses</code> annotation is
+   *         missing.
    */
   protected List<Class<?>> getAnnotatedTestClasses() {
     SuiteClasses annotation = getClass().getAnnotation(SuiteClasses.class);
@@ -52,11 +54,6 @@ public abstract class AbstractTestSuite {
     return classes;
   }
 
-  /**
-   *$
-   * @param check
-   * @return
-   */
   private boolean areAnySuperClassesOfTypeAbstractTestSuite(Class<?> check) {
     while (check != null) {
       if (check.equals(AbstractTestSuite.class)) {
@@ -88,10 +85,6 @@ public abstract class AbstractTestSuite {
     }
   }
 
-  /**
-   * @param regex
-   * @return
-   */
   protected List<ClassMethodPair> getMethodMatching(final String regex) {
     List<ClassMethodPair> classMethodPairs = new Vector<ClassMethodPair>();
     // Get all of the test classes
@@ -160,7 +153,7 @@ public abstract class AbstractTestSuite {
 
   /**
    * Retrieves all of the classes listed in the
-   * <code>@SuiteClasses<code> annotation that match the given regex text.
+   * <code>@SuiteClasses</code> annotation that match the given regex text.
    *$
    * @param regex the text pattern to retrieve.
    * @param runningList the running list of classes to prevent recursion
@@ -178,7 +171,7 @@ public abstract class AbstractTestSuite {
 
   /**
    * Retrieves all of the classes listed in the
-   * <code>@SuiteClasses<code> annotation that match the given regex text.
+   * <code>@SuiteClasses</code> annotation that match the given regex text.
    *$
    * @param regex the text pattern to retrieve.
    * @return The list of classes matching the regex pattern
@@ -252,10 +245,10 @@ public abstract class AbstractTestSuite {
 
   /**
    * Retrieves all of the classes listed in the
-   * <code>@SuiteClasses<code> annotation.
+   * <code>@SuiteClasses</code> annotation.
    *$
-   * @return
-   * @throws InitializationError If the <code>@SuiteClasses<code> annotation is
+   * @return List of SuiteClasses
+   * @throws RuntimeException If the <code>@SuiteClasses</code> annotation is
    *         missing.
    */
   public List<Class<?>> getAllClasses() {
@@ -264,10 +257,10 @@ public abstract class AbstractTestSuite {
 
   /**
    * Gets the name of all of the classes listed within the
-   * <code>@SuiteClasses<code> annotation.
+   * <code>@SuiteClasses</code> annotation.
    *$
    * @return the list of classes.
-   * @throws InitializationError If the <code>@SuiteClasses<code> annotation is
+   * @throws RuntimeException If the <code>@SuiteClasses</code> annotation is
    *         missing.
    */
   public List<String> getAllClassName() {

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/RepeatRule.java

@@ -18,11 +18,9 @@ import org.junit.runners.model.Statement;
  * This JUnit Rule allows you to apply this rule to any test to allow it to run
  * multiple times. This is important if you have a test that fails only
  * "sometimes" and needs to be rerun to find the issue.
- *$
- * This code was originally found here: <a href=
- * "http://www.codeaffine.com/2013/04/10/running-junit-tests-repeatedly-without-loops/"
- * >Running JUnit Tests Repeatedly Without Loops<a>
- *$
+ *
+ * This code was originally found here: <a href="http://www.codeaffine.com/2013/04/10/running-junit-tests-repeatedly-without-loops/">Running JUnit Tests Repeatedly Without Loops</a>
+ *
  * @author Frank Appel
  */
 public class RepeatRule implements TestRule {

wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/test/TestBench.java

@@ -340,7 +340,7 @@ public final class TestBench {
    * Return a single Collection containing all of the DIOCrossConnectFixtures in
    * all two pair combinations
    *$
-   * @return
+   * @return pairs of DIOCrossConnectFixtures
    */
   public Collection<Integer[]> getDIOCrossConnectCollection() {
     Collection<Integer[]> pairs = new ArrayList<Integer[]>();