Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-26 01:51:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix warnings for javadocs

Browse Source 
Change-Id: I818c2086d69eff098543b4d5a554ba9d703e01e8
This commit is contained in:
Joe Ross
2014-10-19 16:38:27 -07:00
parent c52e29432c
commit fc7c015823
14 changed files with 48 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/PIDController.java
View File

@@ -372,10 +372,10 @@ public class PIDController implements LiveWindowSendable, Controller {
}
/**
* Sets the maximum and minimum values expected from the input.
* Sets the maximum and minimum values expected from the input and setpoint.
*
* @param minimumInput the minimum percentage expected from the input
* @param maximumInput the maximum percentage expected from the output
* @param minimumInput the minimum value expected from the input
* @param maximumInput the maximum value expected from the input
*/
public synchronized void setInputRange(double minimumInput, double maximumInput) {
if (minimumInput > maximumInput) {
@@ -442,7 +442,7 @@ public class PIDController implements LiveWindowSendable, Controller {
* Set the percentage error which is considered tolerable for use with
* OnTarget. (Input of 15.0 = 15 percent)
* @param percent error which is tolerable
* @deprecated Use {@link #setPercentTolerance(double) or {@link #setAbsoluteTolerance(double)} instead.
* @deprecated Use {@link #setPercentTolerance(double)} or {@link #setAbsoluteTolerance(double)} instead.
*/
@Deprecated
public synchronized void setTolerance(double percent) {

20
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/command/PIDCommand.java
View File

@@ -95,11 +95,7 @@ public abstract class PIDCommand extends Command implements Sendable {
/**
* Returns the {@link PIDController} used by this {@link PIDCommand}.
* Use this if you would like to fine tune the pid loop.
*
* <p>Notice that calling {@link PIDController#setSetpoint(double) setSetpoint(...)} on the controller
* will not result in the setpoint being trimmed to be in
* the range defined by {@link PIDCommand#setSetpointRange(double, double) setSetpointRange(...)}.</p>
*
*
* @return the {@link PIDController} used by this {@link PIDCommand}
*/
protected PIDController getPIDController() {
@@ -120,7 +116,7 @@ public abstract class PIDCommand extends Command implements Sendable {
/**
* Adds the given value to the setpoint.
* If {@link PIDCommand#setRange(double, double) setRange(...)} was used,
* If {@link PIDCommand#setInputRange(double, double) setInputRange(...)} was used,
* then the bounds will still be honored by this method.
* @param deltaSetpoint the change in the setpoint
*/
@@ -129,7 +125,7 @@ public abstract class PIDCommand extends Command implements Sendable {
}
/**
* Sets the setpoint to the given value. If {@link PIDCommand#setRange(double, double) setRange(...)}
* Sets the setpoint to the given value. If {@link PIDCommand#setInputRange(double, double) setInputRange(...)}
* was called,
* then the given setpoint
* will be trimmed to fit within the range.
@@ -154,6 +150,16 @@ public abstract class PIDCommand extends Command implements Sendable {
protected double getPosition() {
return returnPIDInput();
}
/**
* Sets the maximum and minimum values expected from the input and setpoint.
*
* @param minimumInput the minimum value expected from the input and setpoint
* @param maximumInput the maximum value expected from the input and setpoint
*/
protected void setInputRange(double minimumInput, double maximumInput) {
controller.setInputRange(minimumInput, maximumInput);
}
/**
* Returns the input for the pid loop.

14
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/command/PIDSubsystem.java
View File

@@ -126,10 +126,6 @@ public abstract class PIDSubsystem extends Subsystem implements Sendable {
* Returns the {@link PIDController} used by this {@link PIDSubsystem}.
* Use this if you would like to fine tune the pid loop.
*
* <p>Notice that calling {@link PIDController#setSetpoint(double) setSetpoint(...)} on the controller
* will not result in the setpoint being trimmed to be in
* the range defined by {@link PIDSubsystem#setSetpointRange(double, double) setSetpointRange(...)}.</p>
*
* @return the {@link PIDController} used by this {@link PIDSubsystem}
*/
public PIDController getPIDController() {
@@ -139,7 +135,7 @@ public abstract class PIDSubsystem extends Subsystem implements Sendable {
/**
* Adds the given value to the setpoint.
* If {@link PIDCommand#setRange(double, double) setRange(...)} was used,
* If {@link PIDSubsystem#setInputRange(double, double) setInputRange(...)} was used,
* then the bounds will still be honored by this method.
* @param deltaSetpoint the change in the setpoint
*/
@@ -148,7 +144,7 @@ public abstract class PIDSubsystem extends Subsystem implements Sendable {
}
/**
* Sets the setpoint to the given value. If {@link PIDCommand#setRange(double, double) setRange(...)}
* Sets the setpoint to the given value. If {@link PIDSubsystem#setInputRange(double, double) setInputRange(...)}
* was called,
* then the given setpoint
* will be trimmed to fit within the range.
@@ -197,8 +193,7 @@ public abstract class PIDSubsystem extends Subsystem implements Sendable {
/**
* Set the absolute error which is considered tolerable for use with
* OnTarget. The value is in the same range as the PIDInput values.
* @param t A PIDController.Tolerance object instance that is for example
* AbsoluteTolerance or PercentageTolerance. E.g. setTolerance(new PIDController.AbsoluteTolerance(0.1))
* @param t the absolute tolerance
*/
public void setAbsoluteTolerance(double t) {
controller.setAbsoluteTolerance(t);
@@ -207,8 +202,7 @@ public abstract class PIDSubsystem extends Subsystem implements Sendable {
/**
* Set the percentage error which is considered tolerable for use with
* OnTarget. (Value of 15.0 == 15 percent)
* @param t A PIDController.Tolerance object instance that is for example
* AbsoluteTolerance or PercentageTolerance. E.g. setTolerance(new PIDController.AbsoluteTolerance(0.1))
* @param p the percent tolerance
*/
public void setPercentTolerance(double p) {
controller.setPercentTolerance(p);

3
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/smartdashboard/SmartDashboard.java
View File

@@ -57,7 +57,7 @@ public class SmartDashboard {
//TODO should we reimplement NamedSendable?
/**
* Maps the specified key (where the key is the name of the {@link SmartDashboardNamedData}
* Maps the specified key (where the key is the name of the {@link NamedSendable} SmartDashboardNamedData
* to the specified value in this table.
* The value can be retrieved by calling the get method with a key that is equal to the original key.
* @param value the value
@@ -72,7 +72,6 @@ public class SmartDashboard {
* @param key the key
* @return the value
* @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 {@link SmartDashboardData}
* @throws IllegalArgumentException if the key is null
*/
public static Sendable getData(String key) {

2
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/util/BaseSystemNotInitializedException.java
View File

@@ -16,7 +16,7 @@ package edu.wpi.first.wpilibj.util;
public class BaseSystemNotInitializedException extends RuntimeException {
/**
* Create a new BaseSystemNotInitializedException
* @param msg the message to attach to the exception
* @param message the message to attach to the exception
*/
public BaseSystemNotInitializedException(String message) {
super(message);

2
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/util/BoundaryException.java
View File

@@ -53,7 +53,7 @@ public class BoundaryException extends RuntimeException {
* The lower limit
* @param upper
* The upper limit
* @return
* @return the message for a boundary exception
*/
public static String getMessage(double value, double lower, double upper) {
return "Value must be between " + lower + " and " + upper + ", "