diff --git a/hal/src/main/native/include/hal/HALBase.h b/hal/src/main/native/include/hal/HALBase.h index b4188e8ca9..1fe6b3ab4e 100644 --- a/hal/src/main/native/include/hal/HALBase.h +++ b/hal/src/main/native/include/hal/HALBase.h @@ -77,14 +77,18 @@ int64_t HAL_GetFPGARevision(int32_t* status); /** * Returns the serial number. * - * @return Serial number. + * @param[out] buffer The serial number. + * @param size The maximum characters to copy into buffer. + * @return Number of characters copied into buffer. */ size_t HAL_GetSerialNumber(char* buffer, size_t size); /** * Returns the comments from the roboRIO web interface. * - * @return Comments. + * @param[out] buffer The comments string. + * @param size The maximum characters to copy into buffer. + * @return Number of characters copied into buffer. */ size_t HAL_GetComments(char* buffer, size_t size); diff --git a/wpilibc/src/main/native/include/frc/RobotController.h b/wpilibc/src/main/native/include/frc/RobotController.h index cbb42d001b..c020d34653 100644 --- 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(); diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java index 1dfeb3bc22..8bf9268254 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java @@ -48,6 +48,9 @@ public final 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. */ public static String getComments() {