Deprecate RobotInit

wpilibsuite · May 20, 2024 · 230d511 · 230d511
1 parent 8c420fa
commit 230d511
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 7 deletions.
diff --git a/wpilibc/src/main/native/cpp/TimedRobot.cpp b/wpilibc/src/main/native/cpp/TimedRobot.cpp
@@ -12,14 +12,17 @@
 #include <hal/DriverStation.h>
 #include <hal/FRCUsageReporting.h>
 #include <hal/Notifier.h>
+#include <wpi/deprecated.h>
 
 #include "frc/Errors.h"
 #include "frc/Timer.h"
 
 using namespace frc;
 
 void TimedRobot::StartCompetition() {
+  WPI_IGNORE_DEPRECATED
   RobotInit();
+  WPI_UNIGNORE_DEPRECATED
 
   if constexpr (IsSimulation()) {
     SimulationInit();

diff --git a/wpilibc/src/main/native/include/frc/IterativeRobotBase.h b/wpilibc/src/main/native/include/frc/IterativeRobotBase.h
@@ -63,11 +63,10 @@ class IterativeRobotBase : public RobotBase {
    * which will be called when the robot is first powered on. It will be called
    * exactly one time.
    *
-   * Warning: the Driver Station "Robot Code" light and FMS "Robot Ready"
-   * indicators will be off until RobotInit() exits. Code in RobotInit() that
-   * waits for enable will cause the robot to never indicate that the code is
-   * ready, causing the robot to be bypassed in a match.
+   * Note: This method is functionally identical to the class constructor so
+   * that should be used instead.
    */
+  [[deprecated("Use the robot class constructor instead.")]]
   virtual void RobotInit();
 
   /**

diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/IterativeRobotBase.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/IterativeRobotBase.java
@@ -97,10 +97,12 @@ protected IterativeRobotBase(double period) {
    * <p>Users should override this method for default Robot-wide initialization which will be called
    * when the robot is first powered on. It will be called exactly one time.
    *
-   * <p>Warning: the Driver Station "Robot Code" light and FMS "Robot Ready" indicators will be off
-   * until RobotInit() exits. Code in RobotInit() that waits for enable will cause the robot to
-   * never indicate that the code is ready, causing the robot to be bypassed in a match.
+   * <p>Note: This method is functionally identical to the class constructor so that should be used
+   * instead.
+   *
+   * @deprecated Use the robot class constructor instead.
    */
+  @Deprecated(since = "2025", forRemoval = true)
   public void robotInit() {}
 
   /**

diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/TimedRobot.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/TimedRobot.java
@@ -103,6 +103,7 @@ public void close() {
 
   /** Provide an alternate "main loop" via startCompetition(). */
   @Override
+  @SuppressWarnings("removal")
   public void startCompetition() {
     robotInit();
 

diff --git a/wpilibj/src/test/java/edu/wpi/first/wpilibj/TimedRobotTest.java b/wpilibj/src/test/java/edu/wpi/first/wpilibj/TimedRobotTest.java
@@ -48,6 +48,7 @@ static class MockRobot extends TimedRobot {
     }
 
     @Override
+    @SuppressWarnings("removal")
     public void robotInit() {
       m_robotInitCount.addAndGet(1);
     }