Update docs to add missing channel numbers

Change-Id: I2ffcc84c4801c5bd1062b74f36dd35e06b4834e6
This commit is contained in:
Joe Ross
2015-01-07 20:15:26 -08:00
parent 87e1df068c
commit 0cf7d6f457
5 changed files with 12 additions and 12 deletions

View File

@@ -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);

View File

@@ -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);

View File

@@ -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());