[Doc] Add warning about using user button to docs (NFC)

Fixes #5165
wpilibsuite · Jan 1, 2024 · c916986 · c916986
1 parent 938bf45
commit c916986
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/hal/src/main/java/edu/wpi/first/hal/HALUtil.java b/hal/src/main/java/edu/wpi/first/hal/HALUtil.java
@@ -72,6 +72,10 @@ public final class HALUtil extends JNIWrapper {
   /**
    * Reads the microsecond-resolution timer on the FPGA.
    *
+   * Warning: the User Button is used to stop user programs from automatically loading if it is
+   * held for more then 5 seconds. Because of this, it's not recommended to be used by teams for
+   * any other purpose.
+   *
    * @return The current time in microseconds according to the FPGA (since FPGA reset).
    */
   public static native long getFPGATime();

diff --git a/hal/src/main/native/include/hal/HALBase.h b/hal/src/main/native/include/hal/HALBase.h
@@ -110,6 +110,10 @@ HAL_RuntimeType HAL_GetRuntimeType(void);
 /**
  * Gets the state of the "USER" button on the roboRIO.
  *
+ * @warning the User Button is used to stop user programs from automatically
+ * loading if it is held for more then 5 seconds. Because of this, it's not
+ * recommended to be used by teams for any other purpose.
+ *
  * @param[out] status the error code, or 0 for success
  * @return true if the button is currently pressed down
  */

diff --git a/wpilibc/src/main/native/include/frc/RobotController.h b/wpilibc/src/main/native/include/frc/RobotController.h
@@ -83,6 +83,10 @@ class RobotController {
   /**
    * Get the state of the "USER" button on the roboRIO.
    *
+   * @warning the User Button is used to stop user programs from automatically
+   * loading if it is held for more then 5 seconds. Because of this, it's not
+   * recommended to be used by teams for any other purpose.
+   *
    * @return True if the button is currently pressed down
    */
   static bool GetUserButton();

diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java
@@ -79,6 +79,10 @@ public static long getFPGATime() {
   /**
    * Get the state of the "USER" button on the roboRIO.
    *
+   * Warning: the User Button is used to stop user programs from automatically loading if it is
+   * held for more then 5 seconds. Because of this, it's not recommended to be used by teams for
+   * any other purpose.
+   *
    * @return true if the button is currently pressed down
    */
   public static boolean getUserButton() {