[build] Add checkstyle check for deprecation (#7738)

Ensures java deprecated notation is paired with javadoc and vice versa.
Adds javadoc deprecation for MecanumControllerCommand, ArmFeedForward,
ElevatorFeedforward, and MecanumDriveMotorVoltages
Fixes #7736
Supersedes #7737

Co-authored-by: Joseph Eng <91924258+KangarooKoala@users.noreply.github.com>
This commit is contained in:
sciencewhiz
2025-06-30 00:09:02 -07:00
committed by GitHub
parent ccc9740d56
commit f2dd81c839
5 changed files with 14 additions and 1 deletions

View File

@@ -287,5 +287,6 @@ module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
</module>
<module name="CommentsIndentation" />
<module name="PackageDeclaration" />
<module name="MissingDeprecated"/>
</module>
</module>

View File

@@ -172,6 +172,8 @@ public class MecanumControllerCommand extends Command {
* @param outputDriveVoltages A MecanumDriveMotorVoltages object containing the output motor
* voltages.
* @param requirements The subsystems to require.
* @deprecated Use {@link MecanumVoltagesConsumer} instead of {@code
* Consumer<MecanumDriveMotorVoltages}.
*/
@Deprecated(since = "2025", forRemoval = true)
public MecanumControllerCommand(
@@ -308,6 +310,8 @@ public class MecanumControllerCommand extends Command {
* @param outputDriveVoltages A MecanumDriveMotorVoltages object containing the output motor
* voltages.
* @param requirements The subsystems to require.
* @deprecated Use {@link MecanumVoltagesConsumer} instead of {@code
* Consumer<MecanumDriveMotorVoltages>}.
*/
@Deprecated(since = "2025", forRemoval = true)
public MecanumControllerCommand(

View File

@@ -176,6 +176,7 @@ public class ArmFeedforward implements ProtobufSerializable, StructSerializable
* @param velocityRadPerSec The velocity setpoint.
* @param accelRadPerSecSquared The acceleration setpoint.
* @return The computed feedforward.
* @deprecated Use {@link #calculateWithVelocities(double, double, double)} instead
*/
@Deprecated(forRemoval = true, since = "2025")
public double calculate(
@@ -210,6 +211,7 @@ public class ArmFeedforward implements ProtobufSerializable, StructSerializable
* @param nextVelocity The next velocity setpoint in radians per second.
* @param dt Time between velocity setpoints in seconds.
* @return The computed feedforward in volts.
* @deprecated Use {@link #calculateWithVelocities(double, double, double)} instead.
*/
@SuppressWarnings("removal")
@Deprecated(forRemoval = true, since = "2025")

View File

@@ -173,6 +173,7 @@ public class ElevatorFeedforward implements ProtobufSerializable, StructSerializ
* @param velocity The velocity setpoint.
* @param acceleration The acceleration setpoint.
* @return The computed feedforward.
* @deprecated Use {@link #calculateWithVelocities(double, double)}.
*/
@SuppressWarnings("removal")
@Deprecated(forRemoval = true, since = "2025")

View File

@@ -4,7 +4,12 @@
package edu.wpi.first.math.kinematics;
/** Represents the motor voltages for a mecanum drive drivetrain. */
/**
* Represents the motor voltages for a mecanum drive drivetrain.
*
* @deprecated Use {@link
* edu.wpi.first.wpilibj2.command.MecanumControllerCommand.MecanumVoltagesConsumer}
*/
@Deprecated(since = "2025", forRemoval = true)
public class MecanumDriveMotorVoltages {
/** Voltage of the front left motor. */