From f03e0cdf6a86e8fdb4111bf76d64f73539f19936 Mon Sep 17 00:00:00 2001 From: Ryan Blue Date: Mon, 28 Oct 2024 22:29:42 -0400 Subject: [PATCH] [wpilib] Add explanation for HID GetBumper/Touchpad deprecations (#7304) --- .../main/native/include/frc/hid.h.jinja | 27 +++++++++++++++ .../include/frc/simulation/hidsim.h.jinja | 9 +++++ .../main/native/include/frc/PS4Controller.h | 9 +++++ .../main/native/include/frc/PS5Controller.h | 9 +++++ .../native/include/frc/StadiaController.h | 18 ++++++++++ .../main/native/include/frc/XboxController.h | 18 ++++++++++ .../include/frc/simulation/PS4ControllerSim.h | 3 ++ .../include/frc/simulation/PS5ControllerSim.h | 3 ++ .../frc/simulation/XboxControllerSim.h | 6 ++++ wpilibj/src/generate/main/java/hid.java.jinja | 33 ++++++++++++++----- .../src/generate/main/java/hidsim.java.jinja | 12 ++++--- .../edu/wpi/first/wpilibj/PS4Controller.java | 11 +++++-- .../edu/wpi/first/wpilibj/PS5Controller.java | 11 +++++-- .../wpi/first/wpilibj/StadiaController.java | 22 +++++++++---- .../edu/wpi/first/wpilibj/XboxController.java | 22 +++++++++---- .../wpilibj/simulation/PS4ControllerSim.java | 3 +- .../wpilibj/simulation/PS5ControllerSim.java | 3 +- .../wpilibj/simulation/XboxControllerSim.java | 6 ++-- 18 files changed, 190 insertions(+), 35 deletions(-) diff --git a/wpilibc/src/generate/main/native/include/frc/hid.h.jinja b/wpilibc/src/generate/main/native/include/frc/hid.h.jinja index 4a03a84383..5f26fe2435 100644 --- a/wpilibc/src/generate/main/native/include/frc/hid.h.jinja +++ b/wpilibc/src/generate/main/native/include/frc/hid.h.jinja @@ -122,6 +122,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Read the value of the left bumper (LB) button on the controller. * * @return the state of the button + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetLeftBumperButton instead")]] bool GetLeftBumper() const; @@ -130,6 +133,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Read the value of the right bumper (RB) button on the controller. * * @return the state of the button + * @deprecated Use GetRightBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetRightBumperButton instead")]] bool GetRightBumper() const; @@ -138,6 +144,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetLeftBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonPressed instead")]] bool GetLeftBumperPressed(); @@ -146,6 +155,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetRightBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonPressed instead")]] bool GetRightBumperPressed(); @@ -154,6 +166,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetLeftBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonReleased instead")]] bool GetLeftBumperReleased(); @@ -162,6 +177,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetRightBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonReleased instead")]] bool GetRightBumperReleased(); @@ -170,6 +188,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Read the value of the touchpad button on the controller. * * @return The state of the button. + * @deprecated Use GetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use GetTouchpadButton instead")]] bool GetTouchpad() const; @@ -177,6 +198,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. + * @deprecated Use GetTouchpadButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetTouchpadButtonPressed instead")]] bool GetTouchpadPressed(); @@ -185,6 +209,9 @@ class {{ ConsoleName }}Controller : public GenericHID, * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetTouchpadButtonReleased instead")]] bool GetTouchpadReleased(); diff --git a/wpilibc/src/generate/main/native/include/frc/simulation/hidsim.h.jinja b/wpilibc/src/generate/main/native/include/frc/simulation/hidsim.h.jinja index 6d1ad27f31..7afa873b01 100644 --- a/wpilibc/src/generate/main/native/include/frc/simulation/hidsim.h.jinja +++ b/wpilibc/src/generate/main/native/include/frc/simulation/hidsim.h.jinja @@ -63,6 +63,9 @@ class {{ ConsoleName }}ControllerSim : public GenericHIDSim { * Change the left bumper value of the joystick. * * @param value the new value + * @deprecated Use SetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use SetLeftBumperButton instead")]] void SetLeftBumper(bool value); @@ -71,6 +74,9 @@ class {{ ConsoleName }}ControllerSim : public GenericHIDSim { * Change the right bumper value of the joystick. * * @param value the new value + * @deprecated Use SetRightBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use SetRightBumperButton instead")]] void SetRightBumper(bool value); @@ -79,6 +85,9 @@ class {{ ConsoleName }}ControllerSim : public GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value + * @deprecated Use SetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use SetTouchpadButton instead")]] void SetTouchpad(bool value); diff --git a/wpilibc/src/generated/main/native/include/frc/PS4Controller.h b/wpilibc/src/generated/main/native/include/frc/PS4Controller.h index cd589e76ec..ed8f5a5cf2 100644 --- a/wpilibc/src/generated/main/native/include/frc/PS4Controller.h +++ b/wpilibc/src/generated/main/native/include/frc/PS4Controller.h @@ -526,6 +526,9 @@ class PS4Controller : public GenericHID, * Read the value of the touchpad button on the controller. * * @return The state of the button. + * @deprecated Use GetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use GetTouchpadButton instead")]] bool GetTouchpad() const; @@ -533,6 +536,9 @@ class PS4Controller : public GenericHID, * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. + * @deprecated Use GetTouchpadButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetTouchpadButtonPressed instead")]] bool GetTouchpadPressed(); @@ -541,6 +547,9 @@ class PS4Controller : public GenericHID, * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetTouchpadButtonReleased instead")]] bool GetTouchpadReleased(); diff --git a/wpilibc/src/generated/main/native/include/frc/PS5Controller.h b/wpilibc/src/generated/main/native/include/frc/PS5Controller.h index 31cd9e3021..3a1c9217ee 100644 --- a/wpilibc/src/generated/main/native/include/frc/PS5Controller.h +++ b/wpilibc/src/generated/main/native/include/frc/PS5Controller.h @@ -526,6 +526,9 @@ class PS5Controller : public GenericHID, * Read the value of the touchpad button on the controller. * * @return The state of the button. + * @deprecated Use GetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use GetTouchpadButton instead")]] bool GetTouchpad() const; @@ -533,6 +536,9 @@ class PS5Controller : public GenericHID, * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. + * @deprecated Use GetTouchpadButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetTouchpadButtonPressed instead")]] bool GetTouchpadPressed(); @@ -541,6 +547,9 @@ class PS5Controller : public GenericHID, * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetTouchpadButtonReleased instead")]] bool GetTouchpadReleased(); diff --git a/wpilibc/src/generated/main/native/include/frc/StadiaController.h b/wpilibc/src/generated/main/native/include/frc/StadiaController.h index 6582cc9bbf..025377f600 100644 --- a/wpilibc/src/generated/main/native/include/frc/StadiaController.h +++ b/wpilibc/src/generated/main/native/include/frc/StadiaController.h @@ -541,6 +541,9 @@ class StadiaController : public GenericHID, * Read the value of the left bumper (LB) button on the controller. * * @return the state of the button + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetLeftBumperButton instead")]] bool GetLeftBumper() const; @@ -549,6 +552,9 @@ class StadiaController : public GenericHID, * Read the value of the right bumper (RB) button on the controller. * * @return the state of the button + * @deprecated Use GetRightBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetRightBumperButton instead")]] bool GetRightBumper() const; @@ -557,6 +563,9 @@ class StadiaController : public GenericHID, * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetLeftBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonPressed instead")]] bool GetLeftBumperPressed(); @@ -565,6 +574,9 @@ class StadiaController : public GenericHID, * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetRightBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonPressed instead")]] bool GetRightBumperPressed(); @@ -573,6 +585,9 @@ class StadiaController : public GenericHID, * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetLeftBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonReleased instead")]] bool GetLeftBumperReleased(); @@ -581,6 +596,9 @@ class StadiaController : public GenericHID, * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetRightBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonReleased instead")]] bool GetRightBumperReleased(); diff --git a/wpilibc/src/generated/main/native/include/frc/XboxController.h b/wpilibc/src/generated/main/native/include/frc/XboxController.h index ce2c21e048..222fc2b0f8 100644 --- a/wpilibc/src/generated/main/native/include/frc/XboxController.h +++ b/wpilibc/src/generated/main/native/include/frc/XboxController.h @@ -446,6 +446,9 @@ class XboxController : public GenericHID, * Read the value of the left bumper (LB) button on the controller. * * @return the state of the button + * @deprecated Use GetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetLeftBumperButton instead")]] bool GetLeftBumper() const; @@ -454,6 +457,9 @@ class XboxController : public GenericHID, * Read the value of the right bumper (RB) button on the controller. * * @return the state of the button + * @deprecated Use GetRightBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use GetRightBumperButton instead")]] bool GetRightBumper() const; @@ -462,6 +468,9 @@ class XboxController : public GenericHID, * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetLeftBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonPressed instead")]] bool GetLeftBumperPressed(); @@ -470,6 +479,9 @@ class XboxController : public GenericHID, * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check + * @deprecated Use GetRightBumperButtonPressed instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonPressed instead")]] bool GetRightBumperPressed(); @@ -478,6 +490,9 @@ class XboxController : public GenericHID, * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetLeftBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetLeftBumperButtonReleased instead")]] bool GetLeftBumperReleased(); @@ -486,6 +501,9 @@ class XboxController : public GenericHID, * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. + * @deprecated Use GetRightBumperButtonReleased instead. This function is + * deprecated for removal to make function names consistent to allow the HID + * classes to be automatically generated. */ [[deprecated("Use GetRightBumperButtonReleased instead")]] bool GetRightBumperReleased(); diff --git a/wpilibc/src/generated/main/native/include/frc/simulation/PS4ControllerSim.h b/wpilibc/src/generated/main/native/include/frc/simulation/PS4ControllerSim.h index 79dd5ecec7..a3acbc2467 100644 --- a/wpilibc/src/generated/main/native/include/frc/simulation/PS4ControllerSim.h +++ b/wpilibc/src/generated/main/native/include/frc/simulation/PS4ControllerSim.h @@ -177,6 +177,9 @@ class PS4ControllerSim : public GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value + * @deprecated Use SetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use SetTouchpadButton instead")]] void SetTouchpad(bool value); diff --git a/wpilibc/src/generated/main/native/include/frc/simulation/PS5ControllerSim.h b/wpilibc/src/generated/main/native/include/frc/simulation/PS5ControllerSim.h index e3762bbf20..0b2f371523 100644 --- a/wpilibc/src/generated/main/native/include/frc/simulation/PS5ControllerSim.h +++ b/wpilibc/src/generated/main/native/include/frc/simulation/PS5ControllerSim.h @@ -177,6 +177,9 @@ class PS5ControllerSim : public GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value + * @deprecated Use SetTouchpadButton instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be + * automatically generated. */ [[deprecated("Use SetTouchpadButton instead")]] void SetTouchpad(bool value); diff --git a/wpilibc/src/generated/main/native/include/frc/simulation/XboxControllerSim.h b/wpilibc/src/generated/main/native/include/frc/simulation/XboxControllerSim.h index 06d6ad6d6e..293a7b87bd 100644 --- a/wpilibc/src/generated/main/native/include/frc/simulation/XboxControllerSim.h +++ b/wpilibc/src/generated/main/native/include/frc/simulation/XboxControllerSim.h @@ -149,6 +149,9 @@ class XboxControllerSim : public GenericHIDSim { * Change the left bumper value of the joystick. * * @param value the new value + * @deprecated Use SetLeftBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use SetLeftBumperButton instead")]] void SetLeftBumper(bool value); @@ -157,6 +160,9 @@ class XboxControllerSim : public GenericHIDSim { * Change the right bumper value of the joystick. * * @param value the new value + * @deprecated Use SetRightBumperButton instead. This function is deprecated + * for removal to make function names consistent to allow the HID classes to + * be automatically generated. */ [[deprecated("Use SetRightBumperButton instead")]] void SetRightBumper(bool value); diff --git a/wpilibj/src/generate/main/java/hid.java.jinja b/wpilibj/src/generate/main/java/hid.java.jinja index 48a3d67d43..242bf13f75 100644 --- a/wpilibj/src/generate/main/java/hid.java.jinja +++ b/wpilibj/src/generate/main/java/hid.java.jinja @@ -193,7 +193,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Read the value of the left bumper (LB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getLeftBumperButton} instead + * @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumper() { @@ -204,7 +205,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Read the value of the right bumper (RB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getRightBumperButton} instead + * @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumper() { @@ -215,7 +217,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getLeftBumperButtonPressed} instead + * @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperPressed() { @@ -226,7 +230,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getRightBumperButtonPressed} instead + * @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperPressed() { @@ -237,7 +243,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getLeftBumperButtonReleased} instead + * @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperReleased() { @@ -248,7 +256,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getRightBumperButtonReleased} instead + * @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperReleased() { @@ -259,7 +269,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Read the value of the touchpad on the controller. * * @return The state of the touchpad. - * @deprecated Use {@link getTouchpadButton} instead + * @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpad() { @@ -270,7 +281,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. - * @deprecated Use {@link getTouchpadButtonPressed} instead + * @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadPressed() { @@ -281,7 +294,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. - * @deprecated Use {@link getTouchpadButtonReleased} instead + * @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadReleased() { diff --git a/wpilibj/src/generate/main/java/hidsim.java.jinja b/wpilibj/src/generate/main/java/hidsim.java.jinja index c2f2704bef..fa041ca828 100644 --- a/wpilibj/src/generate/main/java/hidsim.java.jinja +++ b/wpilibj/src/generate/main/java/hidsim.java.jinja @@ -72,7 +72,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim { * Change the value of the left bumper on the joystick. * * @param state the new value - * @deprecated Use {@link setLeftBumperButton} instead + * @deprecated Use {@link setLeftBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setLeftBumper(boolean state) { @@ -83,7 +84,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim { * Change the value of the right bumper on the joystick. * * @param state the new value - * @deprecated Use {@link setRightBumperButton} instead + * @deprecated Use {@link setRightBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setRightBumper(boolean state) { @@ -94,7 +96,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value - * @deprecated Use {@link setTouchpadButton} instead + * @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setTouchpad(boolean value) { @@ -105,7 +108,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value - * @deprecated Use {@link setTouchpadButton} instead + * @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setTouchpad(boolean value) { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS4Controller.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS4Controller.java index 669cd65cfe..70c1ce1c16 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS4Controller.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS4Controller.java @@ -720,7 +720,8 @@ public class PS4Controller extends GenericHID implements Sendable { * Read the value of the touchpad on the controller. * * @return The state of the touchpad. - * @deprecated Use {@link getTouchpadButton} instead + * @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpad() { @@ -731,7 +732,9 @@ public class PS4Controller extends GenericHID implements Sendable { * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. - * @deprecated Use {@link getTouchpadButtonPressed} instead + * @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadPressed() { @@ -742,7 +745,9 @@ public class PS4Controller extends GenericHID implements Sendable { * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. - * @deprecated Use {@link getTouchpadButtonReleased} instead + * @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadReleased() { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS5Controller.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS5Controller.java index 52ca2e91d8..7cd5bfd5f1 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS5Controller.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS5Controller.java @@ -720,7 +720,8 @@ public class PS5Controller extends GenericHID implements Sendable { * Read the value of the touchpad on the controller. * * @return The state of the touchpad. - * @deprecated Use {@link getTouchpadButton} instead + * @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpad() { @@ -731,7 +732,9 @@ public class PS5Controller extends GenericHID implements Sendable { * Whether the touchpad was pressed since the last check. * * @return Whether the touchpad was pressed since the last check. - * @deprecated Use {@link getTouchpadButtonPressed} instead + * @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadPressed() { @@ -742,7 +745,9 @@ public class PS5Controller extends GenericHID implements Sendable { * Whether the touchpad was released since the last check. * * @return Whether the touchpad was released since the last check. - * @deprecated Use {@link getTouchpadButtonReleased} instead + * @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getTouchpadReleased() { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/StadiaController.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/StadiaController.java index 4434586191..5443e5755b 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/StadiaController.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/StadiaController.java @@ -736,7 +736,8 @@ public class StadiaController extends GenericHID implements Sendable { * Read the value of the left bumper (LB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getLeftBumperButton} instead + * @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumper() { @@ -747,7 +748,8 @@ public class StadiaController extends GenericHID implements Sendable { * Read the value of the right bumper (RB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getRightBumperButton} instead + * @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumper() { @@ -758,7 +760,9 @@ public class StadiaController extends GenericHID implements Sendable { * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getLeftBumperButtonPressed} instead + * @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperPressed() { @@ -769,7 +773,9 @@ public class StadiaController extends GenericHID implements Sendable { * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getRightBumperButtonPressed} instead + * @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperPressed() { @@ -780,7 +786,9 @@ public class StadiaController extends GenericHID implements Sendable { * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getLeftBumperButtonReleased} instead + * @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperReleased() { @@ -791,7 +799,9 @@ public class StadiaController extends GenericHID implements Sendable { * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getRightBumperButtonReleased} instead + * @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperReleased() { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/XboxController.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/XboxController.java index 2bc096f8ef..78abae8ed7 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/XboxController.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/XboxController.java @@ -612,7 +612,8 @@ public class XboxController extends GenericHID implements Sendable { * Read the value of the left bumper (LB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getLeftBumperButton} instead + * @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumper() { @@ -623,7 +624,8 @@ public class XboxController extends GenericHID implements Sendable { * Read the value of the right bumper (RB) button on the controller. * * @return The state of the button. - * @deprecated Use {@link getRightBumperButton} instead + * @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumper() { @@ -634,7 +636,9 @@ public class XboxController extends GenericHID implements Sendable { * Whether the left bumper (LB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getLeftBumperButtonPressed} instead + * @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperPressed() { @@ -645,7 +649,9 @@ public class XboxController extends GenericHID implements Sendable { * Whether the right bumper (RB) was pressed since the last check. * * @return Whether the button was pressed since the last check. - * @deprecated Use {@link getRightBumperButtonPressed} instead + * @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperPressed() { @@ -656,7 +662,9 @@ public class XboxController extends GenericHID implements Sendable { * Whether the left bumper (LB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getLeftBumperButtonReleased} instead + * @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getLeftBumperReleased() { @@ -667,7 +675,9 @@ public class XboxController extends GenericHID implements Sendable { * Whether the right bumper (RB) was released since the last check. * * @return Whether the button was released since the last check. - * @deprecated Use {@link getRightBumperButtonReleased} instead + * @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for + * removal to make function names consistent to allow the HID classes to be automatically + * generated. */ @Deprecated(since = "2025", forRemoval = true) public boolean getRightBumperReleased() { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS4ControllerSim.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS4ControllerSim.java index a2f1141abc..889eb18d80 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS4ControllerSim.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS4ControllerSim.java @@ -220,7 +220,8 @@ public class PS4ControllerSim extends GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value - * @deprecated Use {@link setTouchpadButton} instead + * @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setTouchpad(boolean value) { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS5ControllerSim.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS5ControllerSim.java index 090e74435e..6e614a327d 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS5ControllerSim.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS5ControllerSim.java @@ -220,7 +220,8 @@ public class PS5ControllerSim extends GenericHIDSim { * Change the value of the touchpad button on the controller. * * @param value the new value - * @deprecated Use {@link setTouchpadButton} instead + * @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to + * make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setTouchpad(boolean value) { diff --git a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/XboxControllerSim.java b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/XboxControllerSim.java index 8417b777f7..d52fdd84d2 100644 --- a/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/XboxControllerSim.java +++ b/wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/XboxControllerSim.java @@ -184,7 +184,8 @@ public class XboxControllerSim extends GenericHIDSim { * Change the value of the left bumper on the joystick. * * @param state the new value - * @deprecated Use {@link setLeftBumperButton} instead + * @deprecated Use {@link setLeftBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setLeftBumper(boolean state) { @@ -195,7 +196,8 @@ public class XboxControllerSim extends GenericHIDSim { * Change the value of the right bumper on the joystick. * * @param state the new value - * @deprecated Use {@link setRightBumperButton} instead + * @deprecated Use {@link setRightBumperButton} instead. This function is deprecated for removal + * to make function names consistent to allow the HID classes to be automatically generated. */ @Deprecated(since = "2025", forRemoval = true) public void setRightBumper(boolean state) {