[docs] Add missing docs to enum fields (NFC) (#6150)

Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
m10653
2024-01-05 00:36:26 -05:00
committed by GitHub
parent 4210f5635d
commit 13f4460e00
49 changed files with 665 additions and 26 deletions

View File

@@ -20,18 +20,31 @@
* Teams should use HAL_CAN_Dev_kMiscellaneous
*/
HAL_ENUM(HAL_CANDeviceType) {
/// Broadcast.
HAL_CAN_Dev_kBroadcast = 0,
/// Robot controller.
HAL_CAN_Dev_kRobotController = 1,
/// Motor controller.
HAL_CAN_Dev_kMotorController = 2,
/// Relay controller.
HAL_CAN_Dev_kRelayController = 3,
/// Gyro sensor.
HAL_CAN_Dev_kGyroSensor = 4,
/// Accelerometer.
HAL_CAN_Dev_kAccelerometer = 5,
/// Ultrasonic sensor.
HAL_CAN_Dev_kUltrasonicSensor = 6,
/// Gear tooth sensor.
HAL_CAN_Dev_kGearToothSensor = 7,
/// Power distribution.
HAL_CAN_Dev_kPowerDistribution = 8,
/// Pneumatics.
HAL_CAN_Dev_kPneumatics = 9,
/// Miscellaneous.
HAL_CAN_Dev_kMiscellaneous = 10,
/// IO breakout.
HAL_CAN_Dev_kIOBreakout = 11,
/// Firmware update.
HAL_CAN_Dev_kFirmwareUpdate = 31
};
@@ -41,22 +54,39 @@ HAL_ENUM(HAL_CANDeviceType) {
* Teams should use HAL_CAN_Man_kTeamUse.
*/
HAL_ENUM(HAL_CANManufacturer) {
/// Broadcast.
HAL_CAN_Man_kBroadcast = 0,
/// National Instruments.
HAL_CAN_Man_kNI = 1,
/// Luminary Micro.
HAL_CAN_Man_kLM = 2,
/// DEKA Research and Development Corp.
HAL_CAN_Man_kDEKA = 3,
/// Cross the Road Electronics.
HAL_CAN_Man_kCTRE = 4,
/// REV robotics.
HAL_CAN_Man_kREV = 5,
/// Grapple.
HAL_CAN_Man_kGrapple = 6,
/// MindSensors.
HAL_CAN_Man_kMS = 7,
/// Team use.
HAL_CAN_Man_kTeamUse = 8,
/// Kauai Labs.
HAL_CAN_Man_kKauaiLabs = 9,
/// Copperforge.
HAL_CAN_Man_kCopperforge = 10,
/// Playing With Fusion.
HAL_CAN_Man_kPWF = 11,
/// Studica.
HAL_CAN_Man_kStudica = 12,
/// TheThriftyBot.
HAL_CAN_Man_kTheThriftyBot = 13,
/// Redux Robotics.
HAL_CAN_Man_kReduxRobotics = 14,
/// AndyMark.
HAL_CAN_Man_kAndyMark = 15,
/// Vivid-Hosting.
HAL_CAN_Man_kVividHosting = 16
};
/** @} */