Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-02 02:51:42 +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

8
wpilibc/src/main/native/include/frc/ADXRS450_Gyro.h
View File

@@ -18,7 +18,7 @@ namespace frc {
/**
* Use a rate gyro to return the robots heading relative to a starting position.
*
* The Gyro class tracks the robots heading based on the starting position. As
* The %Gyro class tracks the robots heading based on the starting position. As
* the robot rotates the new heading is computed by integrating the rate of
* rotation returned by the sensor. When the class is instantiated, it does a
* short calibration routine where it samples the gyro while at rest to
@@ -26,19 +26,19 @@ namespace frc {
* determine the heading.
*
* This class is for the digital ADXRS450 gyro sensor that connects via SPI.
* Only one instance of an ADXRS Gyro is supported.
* Only one instance of an ADXRS %Gyro is supported.
*/
class ADXRS450_Gyro : public Gyro,
public wpi::Sendable,
public wpi::SendableHelper<ADXRS450_Gyro> {
public:
/**
* Gyro constructor on onboard CS0.
* %Gyro constructor on onboard CS0.
*/
ADXRS450_Gyro();
/**
* Gyro constructor on the specified SPI port.
* %Gyro constructor on the specified SPI port.
*
* @param port The SPI port the gyro is attached to.
*/