diff --git a/wpilibc/src/main/native/include/frc/PneumaticsBase.h b/wpilibc/src/main/native/include/frc/PneumaticsBase.h index 52ae9b0bf0..d8e74d2521 100644 --- a/wpilibc/src/main/native/include/frc/PneumaticsBase.h +++ b/wpilibc/src/main/native/include/frc/PneumaticsBase.h @@ -121,15 +121,18 @@ class PneumaticsBase { /** * Sets solenoids on a pneumatics module. * - * @param mask bitmask to set - * @param values solenoid values + * @param mask Bitmask indicating which solenoids to set. The LSB represents + * solenoid 0. + * @param values Bitmask indicating the desired states of the solenoids. The + * LSB represents solenoid 0. */ virtual void SetSolenoids(int mask, int values) = 0; /** * Gets a bitmask of solenoid values. * - * @return solenoid values + * @return Bitmask containing the state of the solenoids. The LSB represents + * solenoid 0. */ virtual int GetSolenoids() const = 0; @@ -143,7 +146,8 @@ class PneumaticsBase { /** * Get a bitmask of disabled solenoids. * - * @return bitmask of disabled solenoids + * @return Bitmask indicating disabled solenoids. The LSB represents solenoid + * 0. */ virtual int GetSolenoidDisabledList() const = 0; @@ -171,19 +175,21 @@ class PneumaticsBase { virtual bool CheckSolenoidChannel(int channel) const = 0; /** - * Check to see if the masked solenoids can be reserved, and if not reserve - * them. + * Check to see if the solenoids marked in the bitmask can be reserved, and if + * so, reserve them. * - * @param mask The bitmask of solenoids to reserve + * @param mask The bitmask of solenoids to reserve. The LSB represents + * solenoid 0. * @return 0 if successful; mask of solenoids that couldn't be allocated * otherwise */ virtual int CheckAndReserveSolenoids(int mask) = 0; /** - * Unreserve the masked solenoids. + * Unreserve the solenoids marked in the bitmask. * - * @param mask The bitmask of solenoids to unreserve + * @param mask The bitmask of solenoids to unreserve. The LSB represents + * solenoid 0. */ virtual void UnreserveSolenoids(int mask) = 0; diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticsBase.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticsBase.java index 4f4a8973eb..2e514192f5 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticsBase.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticsBase.java @@ -36,15 +36,16 @@ public interface PneumaticsBase extends AutoCloseable { /** * Sets solenoids on a pneumatics module. * - * @param mask mask - * @param values values + * @param mask Bitmask indicating which solenoids to set. The LSB represents solenoid 0. + * @param values Bitmask indicating the desired states of the solenoids. The LSB represents + * solenoid 0. */ void setSolenoids(int mask, int values); /** * Gets a bitmask of solenoid values. * - * @return values + * @return Bitmask containing the state of the solenoids. The LSB represents solenoid 0. */ int getSolenoids(); @@ -58,7 +59,7 @@ public interface PneumaticsBase extends AutoCloseable { /** * Get a bitmask of disabled solenoids. * - * @return bitmask of disabled solenoids + * @return Bitmask indicating disabled solenoids. The LSB represents solenoid 0. */ int getSolenoidDisabledList(); @@ -194,17 +195,17 @@ public interface PneumaticsBase extends AutoCloseable { boolean checkSolenoidChannel(int channel); /** - * Check to see if the masked solenoids can be reserved, and if not reserve them. + * Check to see if the solenoids marked in the bitmask can be reserved, and if so, reserve them. * - * @param mask The bitmask of solenoids to reserve + * @param mask The bitmask of solenoids to reserve. The LSB represents solenoid 0. * @return 0 if successful; mask of solenoids that couldn't be allocated otherwise */ int checkAndReserveSolenoids(int mask); /** - * Unreserve the masked solenoids. + * Unreserve the solenoids marked in the bitmask. * - * @param mask The bitmask of solenoids to unreserve + * @param mask The bitmask of solenoids to unreserve. The LSB represents solenoid 0. */ void unreserveSolenoids(int mask);