[xrp] Copy XRPReference docs from Java to C++ (NFC) (#7388)

This commit is contained in:
Kavin Muralikrishnan
2024-11-16 10:24:21 -05:00
committed by GitHub
parent fff73ee6e1
commit 6eb652e10e
8 changed files with 71 additions and 6 deletions

View File

@@ -79,32 +79,44 @@ class Drivetrain : public frc2::SubsystemBase {
units::meter_t GetAverageDistance();
/**
* Returns the acceleration along the X-axis, in m/s².
* The acceleration in the X-axis.
*
* @return The acceleration of the XRP along the X-axis.
*/
units::meters_per_second_squared_t GetAccelX();
/**
* Returns the acceleration along the Y-axis, in m/s².
* The acceleration in the Y-axis.
*
* @return The acceleration of the XRP along the Y-axis.
*/
units::meters_per_second_squared_t GetAccelY();
/**
* Returns the acceleration along the Z-axis, in m/s².
* The acceleration in the Z-axis.
*
* @return The acceleration of the XRP along the Z-axis.
*/
units::meters_per_second_squared_t GetAccelZ();
/**
* Returns the current angle of the Romi around the X-axis, in degrees.
* Current angle of the XRP around the X-axis.
*
* @return The current angle of the XRP.
*/
units::radian_t GetGyroAngleX();
/**
* Returns the current angle of the Romi around the Y-axis, in degrees.
* Current angle of the XRP around the Y-axis.
*
* @return The current angle of the XRP.
*/
units::radian_t GetGyroAngleY();
/**
* Returns the current angle of the Romi around the Z-axis, in degrees.
* Current angle of the XRP around the Z-axis.
*
* @return The current angle of the XRP.
*/
units::radian_t GetGyroAngleZ();