Skip to content

Commit

Permalink
More formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ThadHouse committed Feb 22, 2025
1 parent 9e8818a commit bdee070
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 2 deletions.
2 changes: 2 additions & 0 deletions wpilibj/src/main/java/edu/wpi/first/wpilibj/CAN.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public class CAN implements Closeable {
* Create a new CAN communication interface with the specific device ID. This uses the team
* manufacturer and device types. The device ID is 6 bits (0-63).
*
* @param busId The bus ID
* @param deviceId The device id
*/
public CAN(int busId, int deviceId) {
Expand All @@ -43,6 +44,7 @@ public CAN(int busId, int deviceId) {
* Create a new CAN communication interface with a specific device ID, manufacturer and device
* type. The device ID is 6 bits, the manufacturer is 8 bits, and the device type is 5 bits.
*
* @param busId The bus ID
* @param deviceId The device ID
* @param deviceManufacturer The device manufacturer
* @param deviceType The device type
Expand Down
2 changes: 2 additions & 0 deletions wpilibj/src/main/java/edu/wpi/first/wpilibj/Compressor.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public class Compressor implements Sendable, AutoCloseable {
/**
* Constructs a compressor for a specified module and type.
*
* @param busId The bus ID
* @param module The module ID to use.
* @param moduleType The module type to use.
*/
Expand All @@ -49,6 +50,7 @@ public Compressor(int busId, int module, PneumaticsModuleType moduleType) {
/**
* Constructs a compressor for a default module and specified type.
*
* @param busId The bus ID
* @param moduleType The module type to use.
*/
public Compressor(int busId, PneumaticsModuleType moduleType) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public enum Value {
/**
* Constructs a double solenoid for a default module of a specific module type.
*
* @param busId The bus ID
* @param moduleType The module type to use.
* @param forwardChannel The forward channel on the module to control.
* @param reverseChannel The reverse channel on the module to control.
Expand All @@ -57,6 +58,7 @@ public DoubleSolenoid(
/**
* Constructs a double solenoid for a specified module of a specific module type.
*
* @param busId The bus ID
* @param module The module of the solenoid module to use.
* @param moduleType The module type to use.
* @param forwardChannel The forward channel on the module to control.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,14 +136,19 @@ private static double psiToVolts(double pressure, double supplyVoltage) {
private final DataStore m_dataStore;
private final int m_handle;

/** Constructs a PneumaticHub with the default ID (1). */
/**
* Constructs a PneumaticHub with the default ID (1).
*
* @param busId The bus ID
*/
public PneumaticHub(int busId) {
this(busId, SensorUtil.getDefaultREVPHModule());
}

/**
* Constructs a PneumaticHub.
*
* @param busId The bus ID
* @param module module number to construct
*/
public PneumaticHub(int busId, int module) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ public interface PneumaticsBase extends AutoCloseable {
/**
* For internal use to get a module for a specific type.
*
* @param busId The bus ID
* @param module module number
* @param type module type
* @return module
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,19 @@ private static void freeModule(DataStore store) {
private final DataStore m_dataStore;
private final int m_handle;

/** Constructs a PneumaticsControlModule with the default ID (0). */
/**
* Constructs a PneumaticsControlModule with the default ID (0).
*
* @param busId The bus ID
*/
public PneumaticsControlModule(int busId) {
this(busId, SensorUtil.getDefaultCTREPCMModule());
}

/**
* Constructs a PneumaticsControlModule.
*
* @param busId The bus ID
* @param module module number to construct
*/
public PneumaticsControlModule(int busId, int module) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public enum ModuleType {
/**
* Constructs a PowerDistribution object.
*
* @param busId The bus ID
* @param module The CAN ID of the PDP/PDH.
* @param moduleType Module type (CTRE or REV).
*/
Expand All @@ -62,6 +63,8 @@ public PowerDistribution(int busId, int module, ModuleType moduleType) {
* Constructs a PowerDistribution object.
*
* <p>Detects the connected PDP/PDH using the default CAN ID (0 for CTRE and 1 for REV).
*
* @param busId The bus ID
*/
@SuppressWarnings("this-escape")
public PowerDistribution(int busId) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,7 @@ public static RadioLEDState getRadioLEDState() {
/**
* Get the current status of the CAN bus.
*
* @param busId The bus ID
* @return The status of the CAN bus
*/
public static CANStatus getCANStatus(int busId) {
Expand Down
2 changes: 2 additions & 0 deletions wpilibj/src/main/java/edu/wpi/first/wpilibj/Solenoid.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public class Solenoid implements Sendable, AutoCloseable {
/**
* Constructs a solenoid for a default module and specified type.
*
* @param busId The bus ID
* @param moduleType The module type to use.
* @param channel The channel the solenoid is on.
*/
Expand All @@ -33,6 +34,7 @@ public Solenoid(final int busId, final PneumaticsModuleType moduleType, final in
/**
* Constructs a solenoid for a specified module and type.
*
* @param busId The bus ID
* @param module The module ID to use.
* @param moduleType The module type to use.
* @param channel The channel the solenoid is on.
Expand Down

0 comments on commit bdee070

Please sign in to comment.