[wpiunits] Fix deprecation javadoc for units negate (#7436)

deprecated javadoc tags aren't inherited
This commit is contained in:
sciencewhiz
2024-11-27 23:03:23 -08:00
committed by GitHub
parent 59dbfc9c2d
commit 49e3e4a0be
26 changed files with 130 additions and 0 deletions

View File

@@ -43,6 +43,11 @@ public interface {{ helpers['type_decl'](name) }} extends Measure<{{ helpers['mt
return ({{ helpers['type_usage'](name) }}) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Acceleration<D extends Unit> extends Measure<AccelerationUnit<D
return (Acceleration<D>) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Angle extends Measure<AngleUnit> {
return (Angle) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface AngularAcceleration extends Measure<AngularAccelerationUnit> {
return (AngularAcceleration) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface AngularMomentum extends Measure<AngularMomentumUnit> {
return (AngularMomentum) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface AngularVelocity extends Measure<AngularVelocityUnit> {
return (AngularVelocity) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Current extends Measure<CurrentUnit> {
return (Current) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Dimensionless extends Measure<DimensionlessUnit> {
return (Dimensionless) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Distance extends Measure<DistanceUnit> {
return (Distance) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Energy extends Measure<EnergyUnit> {
return (Energy) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Force extends Measure<ForceUnit> {
return (Force) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Frequency extends Measure<FrequencyUnit> {
return (Frequency) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface LinearAcceleration extends Measure<LinearAccelerationUnit> {
return (LinearAcceleration) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface LinearMomentum extends Measure<LinearMomentumUnit> {
return (LinearMomentum) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface LinearVelocity extends Measure<LinearVelocityUnit> {
return (LinearVelocity) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Mass extends Measure<MassUnit> {
return (Mass) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface MomentOfInertia extends Measure<MomentOfInertiaUnit> {
return (MomentOfInertia) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Mult<A extends Unit, B extends Unit> extends Measure<MultUnit<A
return (Mult<A, B>) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Per<Dividend extends Unit, Divisor extends Unit> extends Measur
return (Per<Dividend, Divisor>) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Power extends Measure<PowerUnit> {
return (Power) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Resistance extends Measure<ResistanceUnit> {
return (Resistance) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Temperature extends Measure<TemperatureUnit> {
return (Temperature) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Time extends Measure<TimeUnit> {
return (Time) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Torque extends Measure<TorqueUnit> {
return (Torque) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Velocity<D extends Unit> extends Measure<VelocityUnit<D>> {
return (Velocity<D>) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})

View File

@@ -43,6 +43,11 @@ public interface Voltage extends Measure<VoltageUnit> {
return (Voltage) unit().ofBaseUnits(0 - baseUnitMagnitude());
}
/**
* {@inheritDoc}
*
* @deprecated use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2d
*/
@Override
@Deprecated(since = "2025", forRemoval = true)
@SuppressWarnings({"deprecation", "removal"})