[wpilib] Remove Analog Gyro specific docs from Gyro interface (#2596)

This commit is contained in:
sciencewhiz
2020-07-12 15:34:28 -07:00
committed by GitHub
parent 33f7dec5cf
commit f0a34ea64e
3 changed files with 21 additions and 33 deletions

View File

@@ -51,21 +51,19 @@ class ADXRS450_Gyro : public GyroBase {
/**
* Return the actual angle in degrees that the robot is currently facing.
*
* The angle is based on the current accumulator value corrected by the
* oversampling rate, the gyro type and the A/D calibration values.
* The angle is based on integration of the returned rate from the gyro.
* The angle is continuous, that is it will continue from 360->361 degrees.
* This allows algorithms that wouldn't want to see a discontinuity in the
* gyro output as it sweeps from 360 to 0 on the second time around.
*
* @return the current heading of the robot in degrees. This heading is based
* on integration of the returned rate from the gyro.
* @return the current heading of the robot in degrees.
*/
double GetAngle() const override;
/**
* Return the rate of rotation of the gyro
*
* The rate is based on the most recent reading of the gyro analog value
* The rate is based on the most recent reading of the gyro.
*
* @return the current rate in degrees per second
*/