Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +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

3
wpilibc/src/main/native/include/wpi/hardware/discrete/AnalogInput.hpp
View File

@@ -31,8 +31,7 @@ class AnalogInput : public wpi::util::Sendable,
/**
* Construct an analog input.
*
* @param channel The channel number on the roboRIO to represent. 0-3 are
* on-board 4-7 are on the MXP port.
* @param channel The SmartIO channel to use.
*/
explicit AnalogInput(int channel);

2
wpilibc/src/main/native/include/wpi/hardware/discrete/DigitalInput.hpp
View File

@@ -28,7 +28,7 @@ class DigitalInput : public wpi::util::Sendable,
*
* Creates a digital input given a channel.
*
* @param channel The DIO channel 0-9 are on-board, 10-25 are on the MXP port
* @param channel The SmartIO channel
*/
explicit DigitalInput(int channel);

3
wpilibc/src/main/native/include/wpi/hardware/discrete/DigitalOutput.hpp
View File

@@ -27,8 +27,7 @@ class DigitalOutput : public wpi::util::Sendable,
*
* Create a digital output given a channel.
*
* @param channel The digital channel 0-9 are on-board, 10-25 are on the MXP
* port
* @param channel The SmartIO channel
*/
explicit DigitalOutput(int channel);

3
wpilibc/src/main/native/include/wpi/hardware/discrete/PWM.hpp
View File

@@ -51,8 +51,7 @@ class PWM : public wpi::util::Sendable, public wpi::util::SendableHelper<PWM> {
* The allocation is only done to help users ensure that they don't double
* assign channels.
*
* @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
*/
explicit PWM(int channel, bool registerSendable = true);

5
wpilibc/src/main/native/include/wpi/hardware/motor/PWMMotorController.hpp
View File

@@ -92,11 +92,10 @@ class PWMMotorController
protected:
/**
* Constructor for a PWM Motor %Controller connected via PWM.
* Constructor for a PWM Motor Controller connected via PWM.
*
* @param name Name to use for SendableRegistry
* @param channel The PWM channel that the controller is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
* @param channel The SmartIO channel that the controller is attached to.
*/
PWMMotorController(std::string_view name, int channel);

4
wpilibc/src/main/native/include/wpi/hardware/rotation/AnalogPotentiometer.hpp
View File

@@ -34,9 +34,7 @@ class AnalogPotentiometer
* This will calculate the result from the fullRange times the fraction of the
* supply voltage, plus the offset.
*
* @param channel The Analog Input channel number on the roboRIO the
* potentiometer is plugged into. 0-3 are on-board and 4-7
* are on the MXP port.
* @param channel The SmartIO channel this potentiometer is plugged into.
* @param fullRange The value (in desired units) representing the full
* 0-3.3V range of the input.
* @param offset The value (in desired units) representing the

6
wpilibc/src/main/native/include/wpi/hardware/rotation/Encoder.hpp
View File

@@ -37,10 +37,8 @@ class Encoder : public CounterBase,
*
* The counter will start counting immediately.
*
* @param aChannel The a channel DIO channel. 0-9 are on-board, 10-25
* are on the MXP port
* @param bChannel The b channel DIO channel. 0-9 are on-board, 10-25
* are on the MXP port
* @param aChannel The 'a' SmartIO channel.
* @param bChannel The 'b' SmartIO channel.
* @param reverseDirection represents the orientation of the encoder and
* inverts the output values if necessary so forward
* represents positive values.