[wpilib] Add explanation for HID GetBumper/Touchpad deprecations (#7304)

This commit is contained in:
Ryan Blue
2024-10-28 22:29:42 -04:00
committed by GitHub
parent 412c042c6c
commit f03e0cdf6a
18 changed files with 190 additions and 35 deletions

View File

@@ -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();