Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-28 02:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

Browse Source 
The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
wpilibc/src/main/native/include/frc/simulation/BatterySim.h
View File

@@ -19,9 +19,9 @@ class BatterySim {
public:
/**
* Calculate the loaded battery voltage. Use this with
* {@link RoboRioSim#setVInVoltage(double)} to set the simulated battery
* voltage, which can then be retrieved with the {@link
* RobotController#getBatteryVoltage()} method.
* RoboRioSim::SetVInVoltage(double) to set the simulated battery voltage,
* which can then be retrieved with the RobotController::GetBatteryVoltage()
* method.
*
* @param nominalVoltage The nominal battery voltage. Usually 12v.
* @param resistance The forward resistance of the battery. Most batteries
@@ -38,10 +38,10 @@ class BatterySim {
/**
* Calculate the loaded battery voltage. Use this with
* {@link RoboRioSim#setVInVoltage(double)} to set the simulated battery
* voltage, which can then be retrieved with the {@link
* RobotController#getBatteryVoltage()} method. This function assumes a
* nominal voltage of 12v and a resistance of 20 milliohms (0.020 ohms)
* RoboRioSimSetVInVoltage(double) to set the simulated battery voltage, which
* can then be retrieved with the RobotController::GetBatteryVoltage() method.
* This function assumes a nominal voltage of 12V and a resistance of 20
* milliohms (0.020 ohms).
*
* @param currents The currents drawn from the battery.
* @return The battery's voltage under load.