[docs] Add documentation for various HAL/wpilib items (NFC) (#6898)

This commit is contained in:
Ryan Blue
2024-08-01 19:45:20 -04:00
committed by GitHub
parent 244be83d5d
commit ddd64aa70c
37 changed files with 599 additions and 6 deletions

View File

@@ -27,7 +27,7 @@ public class PowerDistribution implements Sendable, AutoCloseable {
/** Power distribution module type. */
public enum ModuleType {
/** CTRE (Cross The Road Electronics) CTRE Power Distribution Panel (PDP). */
/** CTRE (Cross The Road Electronics) Power Distribution Panel (PDP). */
kCTRE(PowerDistributionJNI.CTRE_TYPE),
/** REV Power Distribution Hub (PDH). */
kRev(PowerDistributionJNI.REV_TYPE);
@@ -222,6 +222,8 @@ public class PowerDistribution implements Sendable, AutoCloseable {
/**
* Returns the power distribution faults.
*
* <p>On a CTRE PDP, this will return an object with no faults active.
*
* @return The power distribution faults.
*/
public PowerDistributionFaults getFaults() {
@@ -231,6 +233,8 @@ public class PowerDistribution implements Sendable, AutoCloseable {
/**
* Returns the power distribution sticky faults.
*
* <p>On a CTRE PDP, this will return an object with no faults active.
*
* @return The power distribution sticky faults.
*/
public PowerDistributionStickyFaults getStickyFaults() {