From 05e5feac416fc5e49b60b0f2d20caff10b0bbdb4 Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Thu, 14 Oct 2021 07:28:21 -0700 Subject: [PATCH] [docs] Fix brownout docs (NFC) (#3638) --- hal/src/main/native/include/hal/Power.h | 12 ++++++------ .../src/main/native/include/frc/RobotController.h | 4 ++-- .../java/edu/wpi/first/wpilibj/RobotController.java | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/hal/src/main/native/include/hal/Power.h b/hal/src/main/native/include/hal/Power.h index febda9bb20..afb31863a5 100644 --- a/hal/src/main/native/include/hal/Power.h +++ b/hal/src/main/native/include/hal/Power.h @@ -117,19 +117,19 @@ HAL_Bool HAL_GetUserActive3V3(int32_t* status); int32_t HAL_GetUserCurrentFaults3V3(int32_t* status); /** - * Get the current brownout voltage seting. - * - * Note that this only does anything on the roboRIO 2. - * On the roboRIO it is a no-op. + * Get the current brownout voltage setting. * * @return The brownout voltage */ double HAL_GetBrownoutVoltage(int32_t* status); /** - * Set the voltage the roborio will brownout and disable all outputs. + * Set the voltage the roboRIO will brownout and disable all outputs. * - * @param brownoutVoltage The brownout voltage + * Note that this only does anything on the roboRIO 2. + * On the roboRIO it is a no-op. + * + * @param voltage The brownout voltage */ void HAL_SetBrownoutVoltage(double voltage, int32_t* status); diff --git a/wpilibc/src/main/native/include/frc/RobotController.h b/wpilibc/src/main/native/include/frc/RobotController.h index 245def14cf..e9750f01ba 100644 --- a/wpilibc/src/main/native/include/frc/RobotController.h +++ b/wpilibc/src/main/native/include/frc/RobotController.h @@ -189,14 +189,14 @@ class RobotController { static int GetFaultCount6V(); /** - * Get the current brownout voltage seting. + * Get the current brownout voltage setting. * * @return The brownout voltage */ static units::volt_t GetBrownoutVoltage(); /** - * Set the voltage the roborio will brownout and disable all outputs. + * Set the voltage the roboRIO will brownout and disable all outputs. * * Note that this only does anything on the roboRIO 2. * On the roboRIO it is a no-op. 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 498ed81224..8a7460eafe 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java @@ -214,7 +214,7 @@ public final class RobotController { } /** - * Get the current brownout voltage seting. + * Get the current brownout voltage setting. * * @return The brownout voltage */ @@ -223,7 +223,7 @@ public final class RobotController { } /** - * Set the voltage the roborio will brownout and disable all outputs. + * Set the voltage the roboRIO will brownout and disable all outputs. * *

Note that this only does anything on the roboRIO 2. On the roboRIO it is a no-op. *