diff --git a/wpilibc/wpilibC++Devices/src/DoubleSolenoid.cpp b/wpilibc/wpilibC++Devices/src/DoubleSolenoid.cpp index 006190c71b..bfb9615145 100644 --- a/wpilibc/wpilibC++Devices/src/DoubleSolenoid.cpp +++ b/wpilibc/wpilibC++Devices/src/DoubleSolenoid.cpp @@ -60,8 +60,8 @@ void DoubleSolenoid::InitSolenoid() /** * Constructor. * Uses the default PCM ID of 0 - * @param forwardChannel The forward channel number on the PCM. - * @param reverseChannel The reverse channel number on the PCM. + * @param forwardChannel The forward channel number on the PCM (0..7). + * @param reverseChannel The reverse channel number on the PCM (0..7). */ DoubleSolenoid::DoubleSolenoid(uint32_t forwardChannel, uint32_t reverseChannel) : SolenoidBase (GetDefaultSolenoidModule()) @@ -75,8 +75,8 @@ DoubleSolenoid::DoubleSolenoid(uint32_t forwardChannel, uint32_t reverseChannel) * Constructor. * * @param moduleNumber The CAN ID of the PCM. - * @param forwardChannel The forward channel on the module to control. - * @param reverseChannel The reverse channel on the module to control. + * @param forwardChannel The forward channel on the PCM to control (0..7). + * @param reverseChannel The reverse channel on the PCM to control (0..7). */ DoubleSolenoid::DoubleSolenoid(uint8_t moduleNumber, uint32_t forwardChannel, uint32_t reverseChannel) : SolenoidBase (moduleNumber) diff --git a/wpilibc/wpilibC++Devices/src/Relay.cpp b/wpilibc/wpilibC++Devices/src/Relay.cpp index a4c65e1ee0..6ec6571fb0 100644 --- a/wpilibc/wpilibC++Devices/src/Relay.cpp +++ b/wpilibc/wpilibC++Devices/src/Relay.cpp @@ -65,7 +65,7 @@ void Relay::InitRelay() /** * Relay constructor given a channel. - * @param channel The channel number. + * @param channel The channel number (0-3). * @param direction The direction that the Relay object will control. */ Relay::Relay(uint32_t channel, Relay::Direction direction) diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/DoubleSolenoid.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/DoubleSolenoid.java index 313250de98..ab5e10d5bd 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/DoubleSolenoid.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/DoubleSolenoid.java @@ -76,8 +76,8 @@ public class DoubleSolenoid extends SolenoidBase implements LiveWindowSendable { /** * Constructor. * Uses the default PCM ID of 0 - * @param forwardChannel The forward channel number on the PCM. - * @param reverseChannel The reverse channel number on the PCM. + * @param forwardChannel The forward channel number on the PCM (0..7). + * @param reverseChannel The reverse channel number on the PCM (0..7). */ public DoubleSolenoid(final int forwardChannel, final int reverseChannel) { super(getDefaultSolenoidModule()); @@ -90,8 +90,8 @@ public class DoubleSolenoid extends SolenoidBase implements LiveWindowSendable { * Constructor. * * @param moduleNumber The module number of the solenoid module to use. - * @param forwardChannel The forward channel on the module to control. - * @param reverseChannel The reverse channel on the module to control. + * @param forwardChannel The forward channel on the module to control (0..7). + * @param reverseChannel The reverse channel on the module to control (0..7). */ public DoubleSolenoid(final int moduleNumber, final int forwardChannel, final int reverseChannel) { super(moduleNumber); diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Relay.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Relay.java index ea1ef16774..8d2d06d37c 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Relay.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Relay.java @@ -152,7 +152,7 @@ public class Relay extends SensorBase implements LiveWindowSendable { * Relay constructor given a channel. * * @param channel - * The channel number for this relay. + * The channel number for this relay (0 - 3). * @param direction * The direction that the Relay object will control. */ @@ -169,7 +169,7 @@ public class Relay extends SensorBase implements LiveWindowSendable { * Relay constructor given a channel, allowing both directions. * * @param channel - * The channel number for this relay. + * The channel number for this relay (0 - 3). */ public Relay(final int channel) { this(channel, Direction.kBoth); diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Solenoid.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Solenoid.java index 4d75e70909..15c5307267 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Solenoid.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Solenoid.java @@ -53,7 +53,7 @@ public class Solenoid extends SolenoidBase implements LiveWindowSendable { /** * Constructor using the default PCM ID (0) * - * @param channel The channel on the PCM to control. + * @param channel The channel on the PCM to control (0..7). */ public Solenoid(final int channel) { super(getDefaultSolenoidModule());