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

[docs] Disable doxygen linking for common words that are also classes (#3563)

Browse Source 
Add % in front of name in order to suppress doxygen link creation. https://www.doxygen.nl/manual/autolink.html
This commit is contained in:
sciencewhiz
2021-09-12 15:18:45 -07:00
committed by GitHub
parent d8e0b6c977
commit e7048c8c8b
20 changed files with 59 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibc/src/main/native/include/frc/motorcontrol/DMC60.h
View File

@@ -9,7 +9,7 @@
namespace frc {
/**
* Digilent DMC 60 Motor Controller.
* Digilent DMC 60 Motor %Controller.
*
* Note that the DMC 60 uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users

2
wpilibc/src/main/native/include/frc/motorcontrol/Jaguar.h
View File

@@ -9,7 +9,7 @@
namespace frc {
/**
* Luminary Micro / Vex Robotics Jaguar Motor Controller with PWM control.
* Luminary Micro / Vex Robotics Jaguar Motor %Controller with PWM control.
*
* Note that the Jaguar uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience

2
wpilibc/src/main/native/include/frc/motorcontrol/PWMMotorController.h
View File

@@ -63,7 +63,7 @@ class PWMMotorController : public MotorController,
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

2
wpilibc/src/main/native/include/frc/motorcontrol/PWMSparkMax.h
View File

@@ -9,7 +9,7 @@
namespace frc {
/**
* REV Robotics SPARK MAX Motor Controller.
* REV Robotics SPARK MAX Motor %Controller.
*
* Note that the SPARK MAX uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users

10
wpilibc/src/main/native/include/frc/motorcontrol/PWMTalonFX.h
View File

@@ -9,14 +9,14 @@
namespace frc {
/**
* Cross the Road Electronics (CTRE) Talon FX Motor Controller with PWM
* Cross the Road Electronics (CTRE) %Talon FX Motor %Controller with PWM
* control.
*
* Note that the Talon FX uses the following bounds for PWM values. These
* Note that the %Talon FX uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users
* experience issues such as asymmetric behavior around the deadband or
* inability to saturate the controller in either direction, calibration is
* recommended. The calibration procedure can be found in the Talon FX User
* recommended. The calibration procedure can be found in the %Talon FX User
* Manual available from Cross The Road Electronics.
*
* \li 2.004ms = full "forward"
@@ -28,9 +28,9 @@ namespace frc {
class PWMTalonFX : public PWMMotorController {
public:
/**
* Construct a Talon FX connected via PWM.
* Construct a %Talon FX connected via PWM.
*
* @param channel The PWM channel that the Talon FX is attached to. 0-9 are
* @param channel The PWM channel that the %Talon FX is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
*/
explicit PWMTalonFX(int channel);

10
wpilibc/src/main/native/include/frc/motorcontrol/PWMTalonSRX.h
View File

@@ -9,14 +9,14 @@
namespace frc {
/**
* Cross the Road Electronics (CTRE) Talon SRX Motor Controller with PWM
* Cross the Road Electronics (CTRE) %Talon SRX Motor %Controller with PWM
* control.
*
* Note that the Talon SRX uses the following bounds for PWM values. These
* Note that the %Talon SRX uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users
* experience issues such as asymmetric behavior around the deadband or
* inability to saturate the controller in either direction, calibration is
* recommended. The calibration procedure can be found in the Talon SRX User
* recommended. The calibration procedure can be found in the %Talon SRX User
* Manual available from Cross The Road Electronics.
*
* \li 2.004ms = full "forward"
@@ -28,9 +28,9 @@ namespace frc {
class PWMTalonSRX : public PWMMotorController {
public:
/**
* Construct a Talon SRX connected via PWM.
* Construct a %Talon SRX connected via PWM.
*
* @param channel The PWM channel that the Talon SRX is attached to. 0-9 are
* @param channel The PWM channel that the %Talon SRX is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
*/
explicit PWMTalonSRX(int channel);

10
wpilibc/src/main/native/include/frc/motorcontrol/PWMVictorSPX.h
View File

@@ -9,14 +9,14 @@
namespace frc {
/**
* Cross the Road Electronics (CTRE) Victor SPX Motor Controller with PWM
* Cross the Road Electronics (CTRE) %Victor SPX Motor %Controller with PWM
* control.
*
* Note that the Victor SPX uses the following bounds for PWM values. These
* Note that the %Victor SPX uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users
* experience issues such as asymmetric behavior around the deadband or
* inability to saturate the controller in either direction, calibration is
* recommended. The calibration procedure can be found in the Victor SPX User
* recommended. The calibration procedure can be found in the %Victor SPX User
* Manual available from Cross The Road Electronics.
*
* \li 2.004ms = full "forward"
@@ -28,9 +28,9 @@ namespace frc {
class PWMVictorSPX : public PWMMotorController {
public:
/**
* Construct a Victor SPX connected via PWM.
* Construct a %Victor SPX connected via PWM.
*
* @param channel The PWM channel that the Victor SPX is attached to. 0-9
* @param channel The PWM channel that the %Victor SPX is attached to. 0-9
* are on-board, 10-19 are on the MXP port
*/
explicit PWMVictorSPX(int channel);

2
wpilibc/src/main/native/include/frc/motorcontrol/SD540.h
View File

@@ -9,7 +9,7 @@
namespace frc {
/**
* Mindsensors SD540 Motor Controller.
* Mindsensors SD540 Motor %Controller.
*
* Note that the SD540 uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience

2
wpilibc/src/main/native/include/frc/motorcontrol/Spark.h
View File

@@ -9,7 +9,7 @@
namespace frc {
/**
* REV Robotics SPARK Motor Controller.
* REV Robotics SPARK Motor %Controller.
*
* Note that the SPARK uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience

10
wpilibc/src/main/native/include/frc/motorcontrol/Talon.h
View File

@@ -9,13 +9,13 @@
namespace frc {
/**
* Cross the Road Electronics (CTRE) Talon and Talon SR Motor Controller.
* Cross the Road Electronics (CTRE) %Talon and %Talon SR Motor %Controller.
*
* Note that the Talon uses the following bounds for PWM values. These values
* Note that the %Talon uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience
* issues such as asymmetric behavior around the deadband or inability to
* saturate the controller in either direction, calibration is recommended.
* The calibration procedure can be found in the Talon User Manual available
* The calibration procedure can be found in the %Talon User Manual available
* from CTRE.
*
* \li 2.037ms = full "forward"
@@ -27,9 +27,9 @@ namespace frc {
class Talon : public PWMMotorController {
public:
/**
* Constructor for a Talon (original or Talon SR).
* Constructor for a %Talon (original or %Talon SR).
*
* @param channel The PWM channel number that the Talon is attached to. 0-9
* @param channel The PWM channel number that the %Talon is attached to. 0-9
* are on-board, 10-19 are on the MXP port
*/
explicit Talon(int channel);

16
wpilibc/src/main/native/include/frc/motorcontrol/Victor.h
View File

@@ -9,17 +9,17 @@
namespace frc {
/**
* Vex Robotics Victor 888 Motor Controller.
* Vex Robotics %Victor 888 Motor %Controller.
*
* The Vex Robotics Victor 884 Motor Controller can also be used with this
* The Vex Robotics %Victor 884 Motor %Controller can also be used with this
* class but may need to be calibrated per the Victor 884 user manual.
*
* Note that the Victor uses the following bounds for PWM values. These
* values were determined empirically and optimized for the Victor 888. These
* values should work reasonably well for Victor 884 controllers as well but
* Note that the %Victor uses the following bounds for PWM values. These
* values were determined empirically and optimized for the %Victor 888. These
* values should work reasonably well for %Victor 884 controllers as well but
* if users experience issues such as asymmetric behavior around the deadband
* or inability to saturate the controller in either direction, calibration is
* recommended. The calibration procedure can be found in the Victor 884 User
* recommended. The calibration procedure can be found in the %Victor 884 User
* Manual available from Vex.
*
* \li 2.027ms = full "forward"
@@ -31,9 +31,9 @@ namespace frc {
class Victor : public PWMMotorController {
public:
/**
* Constructor for a Victor.
* Constructor for a %Victor.
*
* @param channel The PWM channel number that the Victor is attached to. 0-9
* @param channel The PWM channel number that the %Victor is attached to. 0-9
* are on-board, 10-19 are on the MXP port
*/
explicit Victor(int channel);

10
wpilibc/src/main/native/include/frc/motorcontrol/VictorSP.h
View File

@@ -9,13 +9,13 @@
namespace frc {
/**
* Vex Robotics Victor SP Motor Controller.
* Vex Robotics %Victor SP Motor %Controller.
*
* Note that the Victor SP uses the following bounds for PWM values. These
* Note that the %Victor SP uses the following bounds for PWM values. These
* values should work reasonably well for most controllers, but if users
* experience issues such as asymmetric behavior around the deadband or
* inability to saturate the controller in either direction, calibration is
* recommended. The calibration procedure can be found in the Victor SP User
* recommended. The calibration procedure can be found in the %Victor SP User
* Manual available from Vex.
*
* \li 2.004ms = full "forward"
@@ -27,9 +27,9 @@ namespace frc {
class VictorSP : public PWMMotorController {
public:
/**
* Constructor for a Victor SP.
* Constructor for a %Victor SP.
*
* @param channel The PWM channel that the VictorSP is attached to. 0-9 are
* @param channel The PWM channel that the Victor SP is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
*/
explicit VictorSP(int channel);