Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix javadoc warnings/errors

Browse Source 
Change-Id: I079699631185f986952bbf4cbb23661f9f9d123d
This commit is contained in:
Joe Ross
2015-10-04 15:08:52 -07:00
committed by Peter Johnson
parent 61760c839a
commit c3c35c604c
23 changed files with 42 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
wpilibj/athena.gradle
View File

@@ -111,6 +111,9 @@ task wpilibjSources(type: Jar, dependsOn: classes) {
task javadoc(type: Javadoc, overwrite: true) {
source sourceSets.athena.allJava, sourceSets.shared.allJava
classpath = files([sourceSets.athena.compileClasspath, sourceSets.shared.compileClasspath])
javadoc.options.links("http://docs.oracle.com/javase/8/docs/api/")
options.addStringOption "tag", "pre:a:Pre-Condition"
// options.addStringOption('Xdoclint:accessibility,syntax,reference,html', '-quiet')
}
task wpilibjJavadoc(type: Jar, dependsOn: javadoc) {

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/CANJaguar.java
View File

@@ -1157,7 +1157,7 @@ public class CANJaguar implements MotorSafety, PIDOutput, CANSpeedController {
/**
* Return whether the controller is enabled.
*
* @returns true if enabled.
* @return true if enabled.
*/
public boolean isEnabled() {
return m_controlEnabled;

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/CANTalon.java
View File

@@ -450,7 +450,7 @@ public class CANTalon implements MotorSafety, PIDOutput, PIDSource, CANSpeedCont
return CanTalonJNI.intp_value(valuep);
}
/**
* @param which feedback sensor to check it if is connected.
* @param feedbackDevice which feedback sensor to check it if is connected.
* @return status of caller's specified sensor type.
*/
public FeedbackDeviceStatus isSensorPresent(FeedbackDevice feedbackDevice) {

4
wpilibj/src/athena/java/edu/wpi/first/wpilibj/InterruptHandlerFunction.java
View File

@@ -12,7 +12,7 @@ import edu.wpi.first.wpilibj.hal.InterruptJNI.InterruptJNIHandlerFunction;
/**
* It is recommended that you use this class in conjunction with classes from
* {@link java.util.concurrent.atomic} as these objects are all thread safe.
*$
*
* @author Jonathan Leitschuh
*
* @param <T> The type of the parameter that should be returned to the the
@@ -40,7 +40,7 @@ public abstract class InterruptHandlerFunction<T> {
/**
* This method is run every time an interrupt is fired.
*$
* @param interruptAssertedMask
* @param interruptAssertedMask Interrupt Mask
* @param param The parameter provided by overriding the
* {@link #overridableParameter()} method.
*/

6
wpilibj/src/athena/java/edu/wpi/first/wpilibj/Joystick.java
View File

@@ -422,7 +422,7 @@ public class Joystick extends GenericHID {
/**
* Get the value of isXbox for the current joystick.
*$
* @param value A boolean that is true if the controller is an xbox
* @return A boolean that is true if the controller is an xbox
* controller.
*/
public boolean getIsXbox() {
@@ -432,7 +432,7 @@ public class Joystick extends GenericHID {
/**
* Get the HID type of the current joystick.
*$
* @param value The HID type value of the current joystick.
* @return The HID type value of the current joystick.
*/
public int getType() {
return m_ds.getJoystickType(m_port);
@@ -441,7 +441,7 @@ public class Joystick extends GenericHID {
/**
* Get the name of the current joystick.
*$
* @param value The name of the current joystick.
* @return The name of the current joystick.
*/
public String getName() {
return m_ds.getJoystickName(m_port);

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/Notifier.java
View File

@@ -88,7 +88,7 @@ public class Notifier {
/**
* Create a Notifier for timer event notification.
*$
* @param handler The handler is called at the notification time which is set
* @param run The handler that is called at the notification time which is set
* using StartSingle or StartPeriodic.
*/
public Notifier(Runnable run) {

4
wpilibj/src/athena/java/edu/wpi/first/wpilibj/RobotDrive.java
View File

@@ -184,7 +184,7 @@ public class RobotDrive implements MotorSafety {
/**
* Drive the motors at "outputMagnitude" and "curve".
* Both outputMagnitude and curve are -1.0 to +1.0 values, where 0.0
* represents stopped and not turning. curve < 0 will turn left and curve > 0
* represents stopped and not turning. {@literal curve < 0 will turn left and curve > 0}
* will turn right.
*
* The algorithm for steering provides a constant turn radius for any normal
@@ -196,7 +196,7 @@ public class RobotDrive implements MotorSafety {
* @param outputMagnitude The speed setting for the outside wheel in a turn,
* forward or backwards, +1 to -1.
* @param curve The rate of turn, constant for different forward speeds. Set
* curve < 0 for left turn or curve > 0 for right turn.
* {@literal curve < 0 for left turn or curve > 0 for right turn.}
* Set curve = e^(-r/w) to get a turn radius r for wheelbase w of your robot.
* Conversely, turn radius r = -ln(curve)*w for a given value of curve and
* wheelbase w.

4
wpilibj/src/athena/java/edu/wpi/first/wpilibj/SPI.java
View File

@@ -202,8 +202,10 @@ public class SPI extends SensorBase {
* and initiates a transfer. If false, this function assumes that data
* is already in the receive FIFO from a previous write.
*
* @param received The buffer to be filled with the received data. Must be
* @param dataReceived The buffer to be filled with the received data. Must be
* created using ByteBuffer.allocateDirect().
*
* @param size The length of the transaction, in bytes
*/
public int read(boolean initiate, ByteBuffer dataReceived, int size) {
if (!dataReceived.isDirect())

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/SensorBase.java
View File

@@ -176,7 +176,7 @@ public abstract class SensorBase { // TODO: Refactor
* Verify that the PDP module number is within limits. module numbers are
* 0-based.
*$
* @param channel The module number to check.
* @param module The module number to check.
*/
protected static void checkPDPModule(final int module) {
if (module < 0 || module > kPDPModules) {

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/Solenoid.java
View File

@@ -108,7 +108,7 @@ public class Solenoid extends SolenoidBase implements LiveWindowSendable {
* Check if solenoid is blacklisted. If a solenoid is shorted, it is added to
* the blacklist and disabled until power cycle, or until faults are cleared.
*
* @see clearAllPCMStickyFaults()
* @see #clearAllPCMStickyFaults()
*
* @return If solenoid is disabled due to short.
*/

2
wpilibj/src/athena/java/edu/wpi/first/wpilibj/image/BinaryImage.java
View File

@@ -128,7 +128,6 @@ public class BinaryImage extends MonoImage {
* Vision Concepts manual.
* @param erosions the number of erosions to perform
* @return a BinaryImage after applying the filter
* @throws NIVisionException
*/
public BinaryImage removeSmallObjects(boolean connectivity8, int erosions)
throws NIVisionException {
@@ -150,7 +149,6 @@ public class BinaryImage extends MonoImage {
* Vision Concepts manual.
* @param erosions the number of erosions to perform
* @return a BinaryImage after applying the filter
* @throws NIVisionException
*/
public BinaryImage removeLargeObjects(boolean connectivity8, int erosions)
throws NIVisionException {

2
wpilibj/src/shared/java/edu/wpi/first/wpilibj/Controller.java
View File

@@ -19,7 +19,7 @@ interface Controller {
/**
* Stops the control loop from running until explicitly re-enabled by calling
* {@link enable()}.
* {@link #enable()}.
*/
public void disable();
}

4
wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/MotorEncoderTest.java
View File

@@ -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

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

@@ -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;

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

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

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

@@ -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();

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

@@ -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 {

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

@@ -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 {

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

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

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

@@ -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;

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

@@ -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() {

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

@@ -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 {

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

@@ -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[]>();