[hal,wpilib] Update documentation for getComments (NFC) (#4879)

2026-06-26 01:51:41 +00:00 · 2022-12-30 07:15:37 -05:00
parent c49a45abbd
commit fe1b62647f
3 changed files with 13 additions and 2 deletions
--- a/wpilibc/src/main/native/include/frc/RobotController.h
+++ b/wpilibc/src/main/native/include/frc/RobotController.h
@@ -54,6 +54,10 @@ class RobotController {
  /**
   * Return the comments from the roboRIO web interface.
   *
+   * The comments string is cached after the first call to this function on the
+   * RoboRIO - restart the robot code to reload the comments string after
+   * changing it in the web interface.
+   *
   * @return The comments from the roboRIO web interface.
   */
  static std::string GetComments();