Don't force public variables to use Hungarian notation (#8774)

People generally have expressed a dislike for the Hungarian notation
used in member variables, especially in examples/templates, and our
styleguide shouldn't be forced on downstream consumers, so this removes
all Hungarian notation from the examples/templates.

There are _some_ benefits to Hungarian for private member variables
(like knowing what's a member vs. local in a PR review) so we'll keep
private member variables the same for now, but public variables should
no longer use Hungarian notation, since it looks much worse. A new PMD
XPath rule has been added to accomplish this goal. Some other
non-compliant variables were fixed for the new rule.
This commit is contained in:
Gold856
2026-04-25 14:32:08 -04:00
committed by GitHub
parent e7e51c9c05
commit 35e8abedeb
443 changed files with 4584 additions and 4789 deletions

View File

@@ -154,49 +154,49 @@ class PneumaticHub : public PneumaticsBase {
*/
struct Faults {
/** Fault on channel 0. */
uint32_t Channel0Fault : 1;
uint32_t channel0Fault : 1;
/** Fault on channel 1. */
uint32_t Channel1Fault : 1;
uint32_t channel1Fault : 1;
/** Fault on channel 2. */
uint32_t Channel2Fault : 1;
uint32_t channel2Fault : 1;
/** Fault on channel 3. */
uint32_t Channel3Fault : 1;
uint32_t channel3Fault : 1;
/** Fault on channel 4. */
uint32_t Channel4Fault : 1;
uint32_t channel4Fault : 1;
/** Fault on channel 5. */
uint32_t Channel5Fault : 1;
uint32_t channel5Fault : 1;
/** Fault on channel 6. */
uint32_t Channel6Fault : 1;
uint32_t channel6Fault : 1;
/** Fault on channel 7. */
uint32_t Channel7Fault : 1;
uint32_t channel7Fault : 1;
/** Fault on channel 8. */
uint32_t Channel8Fault : 1;
uint32_t channel8Fault : 1;
/** Fault on channel 9. */
uint32_t Channel9Fault : 1;
uint32_t channel9Fault : 1;
/** Fault on channel 10. */
uint32_t Channel10Fault : 1;
uint32_t channel10Fault : 1;
/** Fault on channel 11. */
uint32_t Channel11Fault : 1;
uint32_t channel11Fault : 1;
/** Fault on channel 12. */
uint32_t Channel12Fault : 1;
uint32_t channel12Fault : 1;
/** Fault on channel 13. */
uint32_t Channel13Fault : 1;
uint32_t channel13Fault : 1;
/** Fault on channel 14. */
uint32_t Channel14Fault : 1;
uint32_t channel14Fault : 1;
/** Fault on channel 15. */
uint32_t Channel15Fault : 1;
uint32_t channel15Fault : 1;
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
uint32_t compressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
uint32_t compressorOpen : 1;
/** An overcurrent event occurred on a solenoid output. */
uint32_t SolenoidOverCurrent : 1;
uint32_t solenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/**
* Gets whether there is a fault at the specified channel.
@@ -221,23 +221,23 @@ class PneumaticHub : public PneumaticsBase {
*/
struct StickyFaults {
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
uint32_t compressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
uint32_t compressorOpen : 1;
/** An overcurrent event occurred on a solenoid output. */
uint32_t SolenoidOverCurrent : 1;
uint32_t solenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The device's CAN controller experienced a "Bus Off" event. */
uint32_t CanBusOff : 1;
uint32_t canBusOff : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/** The firmware on the device has malfunctioned. */
uint32_t FirmwareFault : 1;
uint32_t firmwareFault : 1;
/** The device has rebooted. */
uint32_t HasReset : 1;
uint32_t hasReset : 1;
};
/**

View File

@@ -184,59 +184,59 @@ class PowerDistribution : public wpi::util::Sendable,
*/
struct Faults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
uint32_t channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
uint32_t channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
uint32_t channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
uint32_t channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
uint32_t channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
uint32_t channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
uint32_t channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
uint32_t channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
uint32_t channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
uint32_t channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
uint32_t channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
uint32_t channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
uint32_t channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
uint32_t channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
uint32_t channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
uint32_t channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
uint32_t channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
uint32_t channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
uint32_t channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
uint32_t channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
uint32_t channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
uint32_t channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
uint32_t channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 1;
uint32_t channel23BreakerFault : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/**
* Gets whether there is a breaker fault at a specified channel.
@@ -263,65 +263,65 @@ class PowerDistribution : public wpi::util::Sendable,
*/
struct StickyFaults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
uint32_t channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
uint32_t channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
uint32_t channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
uint32_t channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
uint32_t channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
uint32_t channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
uint32_t channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
uint32_t channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
uint32_t channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
uint32_t channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
uint32_t channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
uint32_t channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
uint32_t channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
uint32_t channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
uint32_t channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
uint32_t channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
uint32_t channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
uint32_t channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
uint32_t channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
uint32_t channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
uint32_t channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
uint32_t channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
uint32_t channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 1;
uint32_t channel23BreakerFault : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The device's CAN controller experienced a "Bus Off" event. */
uint32_t CanBusOff : 1;
uint32_t canBusOff : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/** The firmware on the device has malfunctioned. */
uint32_t FirmwareFault : 1;
uint32_t firmwareFault : 1;
/** The device has rebooted. */
uint32_t HasReset : 1;
uint32_t hasReset : 1;
/**
* Gets whether there is a sticky breaker fault at the specified channel.