diff --git a/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java b/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java index 54cefba333..02981c2212 100644 --- a/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java +++ b/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java @@ -54,7 +54,7 @@ public abstract class Button extends Trigger { /** * Toggles the command whenever the button is pressed (on then off then on) - * @param command + * @param command the command to start */ public void toggleWhenPressed(final Command command) { toggleWhenActive(command); @@ -62,7 +62,7 @@ public abstract class Button extends Trigger { /** * Cancel the command when the button is pressed - * @param command + * @param command the command to start */ public void cancelWhenPressed(final Command command) { cancelWhenActive(command); diff --git a/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/smartdashboard/SmartDashboard.java b/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/smartdashboard/SmartDashboard.java index c658a20a09..b7c92ead6b 100644 --- a/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/smartdashboard/SmartDashboard.java +++ b/wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/smartdashboard/SmartDashboard.java @@ -149,7 +149,7 @@ public class SmartDashboard { * @param key the key * @param defaultValue the value returned if the key is undefined * @return the value - * @throws NoSuchEleNetworkTableKeyNotDefinedmentException if there is no value mapped to by the key + * @throws NetworkTableKeyNotDefined if there is no value mapped to by the key * @throws IllegalArgumentException if the value mapped to by the key is not a double * @throws IllegalArgumentException if the key is null */ @@ -241,7 +241,7 @@ public class SmartDashboard { * @param key the key * @param defaultValue the value returned if the key is undefined * @return the value - * @throws NetworkTableKeyNotDefined if there is no value mapped to by the key + * @throws TableKeyNotDefinedException if there is no value mapped to by the key * @throws IllegalArgumentException if the value mapped to by the key is not an int * @throws IllegalArgumentException if the key is null */ @@ -274,7 +274,7 @@ public class SmartDashboard { * @deprecated Use {@link #getNumber(java.lang.String) getNumber} instead * @param key the key * @return the value - * @throws NoSuchEleNetworkTableKeyNotDefinedmentException if there is no value mapped to by the key + * @throws TableKeyNotDefinedException if there is no value mapped to by the key * @throws IllegalArgumentException if the value mapped to by the key is not a double * @throws IllegalArgumentException if the key is null */ @@ -289,7 +289,7 @@ public class SmartDashboard { * @param key the key * @param defaultValue the value returned if the key is undefined * @return the value - * @throws NoSuchEleNetworkTableKeyNotDefinedmentException if there is no value mapped to by the key + * @throws TableKeyNotDefinedException if there is no value mapped to by the key * @throws IllegalArgumentException if the value mapped to by the key is not a double * @throws IllegalArgumentException if the key is null */ diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/CANTalon.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/CANTalon.java index dd256c6ab1..cde7b2fa56 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/CANTalon.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/CANTalon.java @@ -360,7 +360,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { /** * Get the current proportional constant. * - * @returns double proportional constant for current profile. + * @return double proportional constant for current profile. * @throws IllegalStateException if not in Position of Speed mode. */ public double getP() { @@ -515,7 +515,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * Set the proportional value of the currently selected profile. * * @param p Proportional constant for the currently selected PID profile. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setP(double p) { m_impl.SetPgain(m_profile, p); @@ -525,7 +525,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * Set the integration constant of the currently selected profile. * * @param i Integration constant for the currently selected PID profile. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setI(double i) { m_impl.SetIgain(m_profile, i); @@ -535,7 +535,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * Set the derivative constant of the currently selected profile. * * @param d Derivative constant for the currently selected PID profile. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setD(double d) { m_impl.SetDgain(m_profile, d); @@ -545,7 +545,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * Set the feedforward value of the currently selected profile. * * @param f Feedforward constant for the currently selected PID profile. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setF(double f) { m_impl.SetFgain(m_profile, f); @@ -560,7 +560,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * An izone value of 0 means no difference from a standard PIDF loop. * * @param izone Width of the integration zone. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setIZone(int izone) { m_impl.SetIzone(m_profile, izone); @@ -573,7 +573,7 @@ public class CANTalon implements MotorSafety, PIDOutput, SpeedController { * Only affects position and speed closed loop modes. * * @param rampRate Maximum change in voltage, in volts / sec. - * @see setProfile For selecting a certain profile. + * @see #setProfile For selecting a certain profile. */ public void setCloseLoopRampRate(double rampRate) { // CanTalonSRX takes units of Throttle (0 - 1023) / 10ms. diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/InterruptableSensorBase.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/InterruptableSensorBase.java index 0fbb221f7a..af325f79ab 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/InterruptableSensorBase.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/InterruptableSensorBase.java @@ -107,7 +107,7 @@ public abstract class InterruptableSensorBase extends SensorBase { /** * Request one of the 8 interrupts synchronously on this digital input. Request * interrupts in synchronous mode where the user program will have to - * explicitly wait for the interrupt to occur using {@link waitForInterrupt}. + * explicitly wait for the interrupt to occur using {@link #waitForInterrupt}. * The default is interrupt on rising edges only. */ public void requestInterrupts() { diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Preferences.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Preferences.java index 544da698a1..fc58b21da2 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Preferences.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Preferences.java @@ -814,7 +814,7 @@ public class Preferences { * Returns whether or not the given string is ok to use in the * preference table. * - * @param value + * @param value the string to check * @return true if the given string is ok to use in the preference table */ public static boolean isAcceptable(String value) { diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SerialPort.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SerialPort.java index a991f555bf..2c5149d1e4 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SerialPort.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SerialPort.java @@ -264,7 +264,7 @@ public class SerialPort { * Set the type of flow control to enable on this port. * * By default, flow control is disabled. - * @param flowControl + * @param flowControl the FlowControl value to use */ public void setFlowControl(FlowControl flowControl) { ByteBuffer status = ByteBuffer.allocateDirect(4); diff --git a/wpilibj/wpilibJavaFinal/pom.xml b/wpilibj/wpilibJavaFinal/pom.xml index 00c943ef70..9d6dea3a56 100644 --- a/wpilibj/wpilibJavaFinal/pom.xml +++ b/wpilibj/wpilibJavaFinal/pom.xml @@ -1,74 +1,81 @@ + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4.0.0 edu.wpi.first.wpilibj wpilibJavaFinal jar 0.1.0-SNAPSHOT - + edu.wpi.first.wpilib.templates.athena library-jar 0.1.0-SNAPSHOT ../../maven-utilities/athena/library-jar/pom.xml - + docline-java8-disable - [1.8, + [1.8, - + org.apache.maven.plugins maven-javadoc-plugin -Xdoclint:none + + + pre + a + Precondition: + + - + - + - - edu.wpi.first.wpilibj - wpilibJava - 0.1.0-SNAPSHOT - - - edu.wpi.first.wpilibj - wpilibJavaDevices - 0.1.0-SNAPSHOT - - - edu.wpi.first.wpilibj - wpilibJavaJNI - 0.1.0-SNAPSHOT - so - - - - edu.wpi.first.wpilibj - wpilibJava - 0.1.0-SNAPSHOT - sources - - - edu.wpi.first.wpilibj - wpilibJavaDevices - 0.1.0-SNAPSHOT - sources - + + edu.wpi.first.wpilibj + wpilibJava + 0.1.0-SNAPSHOT + + + edu.wpi.first.wpilibj + wpilibJavaDevices + 0.1.0-SNAPSHOT + + + edu.wpi.first.wpilibj + wpilibJavaJNI + 0.1.0-SNAPSHOT + so + + + + edu.wpi.first.wpilibj + wpilibJava + 0.1.0-SNAPSHOT + sources + + + edu.wpi.first.wpilibj + wpilibJavaDevices + 0.1.0-SNAPSHOT + sources + - + org.apache.maven.plugins maven-antrun-plugin @@ -96,7 +103,7 @@ - + @@ -112,7 +119,7 @@ - + @@ -128,12 +135,12 @@ generate-sources - + - + generate-sources @@ -172,17 +179,16 @@ - - org.apache.maven.plugins - maven-javadoc-plugin + + org.apache.maven.plugins + maven-javadoc-plugin - - edu/wpi/first/wpilibj/image/ - edu/wpi/first/wpilibj/camera/ - edu/wpi/first/wpilibj/visa/ - edu/wpi/first/wpilibj/SerialPort.java - - true + + edu/wpi/first/wpilibj/image/ + edu/wpi/first/wpilibj/camera/ + edu/wpi/first/wpilibj/visa/ + + true @@ -201,52 +207,52 @@ - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - - org.apache.maven.plugins - - - maven-dependency-plugin - - [2.8,) - - copy - - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - [2.8,) - - unpack - - - - - - - - - - - - + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + + org.apache.maven.plugins + + + maven-dependency-plugin + + [2.8,) + + copy + + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + [2.8,) + + unpack + + + + + + + + + + + +