fix javadoc warnings/errors

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

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;

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

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.
*/

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

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

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.

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

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

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.
*/

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 {