Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-26 01:51:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

[hal,wpilib] Remove MXP mentions in API docs (NFC) (#8694)

Browse Source
This commit is contained in:
Gold856
2026-03-20 19:48:53 -04:00
committed by GitHub
parent fb4bcefabc
commit f1aa84aecf
42 changed files with 65 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
wpilibj/src/main/java/org/wpilib/hardware/discrete/AnalogInput.java
View File

@@ -15,13 +15,6 @@ import org.wpilib.util.sendable.SendableRegistry;
* Analog channel class.
*
* <p>Each analog channel is read from hardware as a 12-bit number representing 0V to 3.3V.
*
* <p>Connected to each analog channel is an averaging and oversampling engine. This engine
* accumulates the specified ( by setAverageBits() and setOversampleBits() ) number of samples
* before returning a new value. This is not a sliding window average. The only difference between
* the oversampled samples and the averaged samples is that the oversampled samples are simply
* accumulated effectively increasing the resolution, while the averaged samples are divided by the
* number of samples to retain the resolution, but get more stable values.
*/
public class AnalogInput implements Sendable, AutoCloseable {
int m_port; // explicit no modifier, private and package accessible.
@@ -30,7 +23,7 @@ public class AnalogInput implements Sendable, AutoCloseable {
/**
* Construct an analog channel.
*
* @param channel The channel number to represent. 0-3 are on-board 4-7 are on the MXP port.
* @param channel The SmartIO channel for the analog input.
*/
@SuppressWarnings("this-escape")
public AnalogInput(final int channel) {

2
wpilibj/src/main/java/org/wpilib/hardware/discrete/DigitalInput.java
View File

@@ -25,7 +25,7 @@ public class DigitalInput implements AutoCloseable, Sendable {
/**
* Create an instance of a Digital Input class. Creates a digital input given a channel.
*
* @param channel the DIO channel for the digital input 0-9 are on-board, 10-25 are on the MXP
* @param channel the SmartIO channel for the digital input
*/
@SuppressWarnings("this-escape")
public DigitalInput(int channel) {

3
wpilibj/src/main/java/org/wpilib/hardware/discrete/DigitalOutput.java
View File

@@ -26,8 +26,7 @@ public class DigitalOutput implements AutoCloseable, Sendable {
/**
* Create an instance of a digital output. Create an instance of a digital output given a channel.
*
* @param channel the DIO channel to use for the digital output. 0-9 are on-board, 10-25 are on
* the MXP
* @param channel the SmartIO channel to use for the digital output.
*/
@SuppressWarnings("this-escape")
public DigitalOutput(int channel) {

4
wpilibj/src/main/java/org/wpilib/hardware/discrete/PWM.java
View File

@@ -42,7 +42,7 @@ public class PWM implements Sendable, AutoCloseable {
*
* <p>By default, adds itself to SendableRegistry.
*
* @param channel The PWM channel number. 0-9 are on-board, 10-19 are on the MXP port
* @param channel The SmartIO channel number.
*/
public PWM(final int channel) {
this(channel, true);
@@ -51,7 +51,7 @@ public class PWM implements Sendable, AutoCloseable {
/**
* Allocate a PWM given a channel.
*
* @param channel The PWM channel number. 0-9 are on-board, 10-19 are on the MXP port
* @param channel The SmartIO channel number.
* @param registerSendable If true, adds this instance to SendableRegistry
*/
@SuppressWarnings("this-escape")