From ada92fa028f3bfbb70775734f07fb8f64ecac2fc Mon Sep 17 00:00:00 2001 From: Michael Richters Date: Mon, 7 Jun 2021 15:58:23 -0500 Subject: [PATCH] Add removal dates for deprecated plugin functions and variables Signed-off-by: Michael Richters --- .../kaleidoscope/plugin/HostPowerManagement.h | 3 ++- .../kaleidoscope/plugin/LED-ActiveModColor.h | 3 ++- .../src/kaleidoscope/plugin/OneShot.h | 24 ++++++++++++------- 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/plugins/Kaleidoscope-HostPowerManagement/src/kaleidoscope/plugin/HostPowerManagement.h b/plugins/Kaleidoscope-HostPowerManagement/src/kaleidoscope/plugin/HostPowerManagement.h index 3d2ebe09..6b8b9676 100644 --- a/plugins/Kaleidoscope-HostPowerManagement/src/kaleidoscope/plugin/HostPowerManagement.h +++ b/plugins/Kaleidoscope-HostPowerManagement/src/kaleidoscope/plugin/HostPowerManagement.h @@ -22,7 +22,8 @@ #define _DEPRECATED_MESSAGE_ENABLEWAKEUP \ "The HostPowerManagement.enableWakeup() call is not necessary anymore,\n" \ "the firmware supports wakeup by default now. The line can be safely\n" \ - "removed." + "removed.\n" \ + "This function will be removed after 2021-08-01." namespace kaleidoscope { namespace plugin { diff --git a/plugins/Kaleidoscope-LED-ActiveModColor/src/kaleidoscope/plugin/LED-ActiveModColor.h b/plugins/Kaleidoscope-LED-ActiveModColor/src/kaleidoscope/plugin/LED-ActiveModColor.h index bed341be..3e5124b1 100644 --- a/plugins/Kaleidoscope-LED-ActiveModColor/src/kaleidoscope/plugin/LED-ActiveModColor.h +++ b/plugins/Kaleidoscope-LED-ActiveModColor/src/kaleidoscope/plugin/LED-ActiveModColor.h @@ -29,7 +29,8 @@ "Please use the following methods instead: \n" \ " - for `highlight_color` => `setHighlightColor(color)` \n" \ " - for `oneshot_color` => `setOneShotColor(color)` \n" \ - " - for `sticky_color` => `setStickyColor(color)`" + " - for `sticky_color` => `setStickyColor(color)` \n" \ + "These variables will be removed after 2021-08-01." namespace kaleidoscope { namespace plugin { diff --git a/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h b/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h index f626c4a7..6072a1ed 100644 --- a/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h +++ b/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h @@ -26,33 +26,41 @@ // Deprecation warning messages #define _DEPRECATED_MESSAGE_ONESHOT_TIMEOUT \ "The `OneShot.time_out` variable is deprecated. Please use the\n" \ - "`OneShot.setTimeout()` function instead." + "`OneShot.setTimeout()` function instead.\n" \ + "This variable will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_HOLD_TIMEOUT \ "The `OneShot.hold_time_out` variable is deprecated. Please use the\n" \ - "`OneShot.setHoldTimeout()` function instead." + "`OneShot.setHoldTimeout()` function instead.\n" \ + "This variable will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_DOUBLE_TAP_TIMEOUT \ "The `OneShot.double_tap_time_out` variable is deprecated. Please use the\n" \ - "`OneShot.setDoubleTapTimeout()` function instead." + "`OneShot.setDoubleTapTimeout()` function instead.\n" \ + "This variable will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_INJECT \ - "The `OneShot.inject(key, key_state)` function has been deprecated." + "The `OneShot.inject(key, key_state)` function has been deprecated.\n" \ + "This function will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_ISACTIVE_KEY \ "The `OneShot.isActive(key)` function is deprecated. Please use\n" \ - "`OneShot.isActive(key_addr)` instead, if possible." + "`OneShot.isActive(key_addr)` instead, if possible.\n" \ + "This function will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_ISSTICKY_KEY \ "The `OneShot.isSticky(key)` function is deprecated. Please use\n" \ - "`OneShot.isSticky(key_addr)` instead, if possible." + "`OneShot.isSticky(key_addr)` instead, if possible.\n" \ + "This function will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_ISPRESSED \ "The `OneShot.isPressed()` function is deprecated. This function now\n" \ - "always returns false." + "always returns false.\n" \ + "This function will be removed after 2021-08-01." #define _DEPRECATED_MESSAGE_ONESHOT_ISMODIFIERACTIVE \ - "The `OneShot.isModifierActive()` function is deprecated." + "The `OneShot.isModifierActive()` function is deprecated.\n" \ + "This function will be removed after 2021-08-01." // ---------------------------------------------------------------------------- // Keymap macros