mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-23 01:21:42 +00:00
[docs] Add missing docs to enum fields (NFC) (#6150)
Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
@@ -23,18 +23,31 @@ public final class CANAPITypes {
|
||||
* Device Types</a>
|
||||
*/
|
||||
public enum CANDeviceType {
|
||||
/** Broadcast. */
|
||||
kBroadcast(0),
|
||||
/** Robot controller. */
|
||||
kRobotController(1),
|
||||
/** Motor controller. */
|
||||
kMotorController(2),
|
||||
/** Relay controller. */
|
||||
kRelayController(3),
|
||||
/** Gyro sensor. */
|
||||
kGyroSensor(4),
|
||||
/** Accelerometer. */
|
||||
kAccelerometer(5),
|
||||
/** Ultrasonic sensor. */
|
||||
kUltrasonicSensor(6),
|
||||
/** Gear tooth sensor. */
|
||||
kGearToothSensor(7),
|
||||
/** Power distribution. */
|
||||
kPowerDistribution(8),
|
||||
/** Pneumatics. */
|
||||
kPneumatics(9),
|
||||
/** Miscellaneous. */
|
||||
kMiscellaneous(10),
|
||||
/** IO breakout. */
|
||||
kIOBreakout(11),
|
||||
/** Firmware update. */
|
||||
kFirmwareUpdate(31);
|
||||
|
||||
@SuppressWarnings("PMD.MemberName")
|
||||
@@ -56,22 +69,39 @@ public final class CANAPITypes {
|
||||
* Manufacturer IDs</a>
|
||||
*/
|
||||
public enum CANManufacturer {
|
||||
/** Broadcast. */
|
||||
kBroadcast(0),
|
||||
/** National Instruments. */
|
||||
kNI(1),
|
||||
/** Luminary Micro. */
|
||||
kLM(2),
|
||||
/** DEKA Research and Development Corp. */
|
||||
kDEKA(3),
|
||||
/** Cross the Road Electronics. */
|
||||
kCTRE(4),
|
||||
/** REV Robotics. */
|
||||
kREV(5),
|
||||
/** Grapple. */
|
||||
kGrapple(6),
|
||||
/** MindSensors. */
|
||||
kMS(7),
|
||||
/** Team use. */
|
||||
kTeamUse(8),
|
||||
/** Kauai Labs. */
|
||||
kKauaiLabs(9),
|
||||
/** Copperforge. */
|
||||
kCopperforge(10),
|
||||
/** Playing With Fusion. */
|
||||
kPWF(11),
|
||||
/** Studica. */
|
||||
kStudica(12),
|
||||
/** TheThriftyBot. */
|
||||
kTheThriftyBot(13),
|
||||
/** Redux Robotics. */
|
||||
kReduxRobotics(14),
|
||||
/** AndyMark. */
|
||||
kAndyMark(15),
|
||||
/** Vivid-Hosting. */
|
||||
kVividHosting(16);
|
||||
|
||||
@SuppressWarnings("PMD.MemberName")
|
||||
|
||||
@@ -16,9 +16,13 @@ package edu.wpi.first.hal;
|
||||
* edu.wpi.first.wpilibj.ADXRS450_Gyro} for an example implementation.
|
||||
*/
|
||||
public class SimDevice implements AutoCloseable {
|
||||
/** Sim device direction. */
|
||||
public enum Direction {
|
||||
/** Input direction for simulation devices. */
|
||||
kInput(SimDeviceJNI.kInput),
|
||||
/** Output direction for simulation devices. */
|
||||
kOutput(SimDeviceJNI.kOutput),
|
||||
/** Bidirectional direction for simulation devices. */
|
||||
kBidir(SimDeviceJNI.kBidir);
|
||||
|
||||
public final int m_value;
|
||||
|
||||
Reference in New Issue
Block a user