mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-23 01:21:42 +00:00
[docs] Add missing JavaDocs (#6146)
This commit is contained in:
@@ -33,10 +33,10 @@ class WPILIB_DLLEXPORT ArmFeedforward {
|
||||
/**
|
||||
* Creates a new ArmFeedforward with the specified gains.
|
||||
*
|
||||
* @param kS The static gain, in volts.
|
||||
* @param kS The static gain, in volts.
|
||||
* @param kG The gravity gain, in volts.
|
||||
* @param kV The velocity gain, in volt seconds per radian.
|
||||
* @param kA The acceleration gain, in volt seconds² per radian.
|
||||
* @param kV The velocity gain, in volt seconds per radian.
|
||||
* @param kA The acceleration gain, in volt seconds² per radian.
|
||||
*/
|
||||
constexpr ArmFeedforward(
|
||||
units::volt_t kS, units::volt_t kG, units::unit_t<kv_unit> kV,
|
||||
@@ -175,9 +175,16 @@ class WPILIB_DLLEXPORT ArmFeedforward {
|
||||
return MaxAchievableAcceleration(-maxVoltage, angle, velocity);
|
||||
}
|
||||
|
||||
/// The static gain, in volts.
|
||||
const units::volt_t kS;
|
||||
|
||||
/// The gravity gain, in volts.
|
||||
const units::volt_t kG;
|
||||
|
||||
/// The velocity gain, in volt seconds per radian.
|
||||
const units::unit_t<kv_unit> kV;
|
||||
|
||||
/// The acceleration gain, in volt seconds² per radian.
|
||||
const units::unit_t<ka_unit> kA;
|
||||
};
|
||||
} // namespace frc
|
||||
|
||||
@@ -12,7 +12,10 @@ namespace frc {
|
||||
* Motor voltages for a differential drive.
|
||||
*/
|
||||
struct DifferentialDriveWheelVoltages {
|
||||
/// Left wheel voltage.
|
||||
units::volt_t left = 0_V;
|
||||
|
||||
/// Right wheel voltage.
|
||||
units::volt_t right = 0_V;
|
||||
};
|
||||
|
||||
|
||||
@@ -182,9 +182,16 @@ class ElevatorFeedforward {
|
||||
return MaxAchievableAcceleration(-maxVoltage, velocity);
|
||||
}
|
||||
|
||||
/// The static gain.
|
||||
const units::volt_t kS;
|
||||
|
||||
/// The gravity gain.
|
||||
const units::volt_t kG;
|
||||
|
||||
/// The velocity gain.
|
||||
const units::unit_t<kv_unit> kV;
|
||||
|
||||
/// The acceleration gain.
|
||||
const units::unit_t<ka_unit> kA;
|
||||
};
|
||||
} // namespace frc
|
||||
|
||||
@@ -160,8 +160,13 @@ class SimpleMotorFeedforward {
|
||||
return MaxAchievableAcceleration(-maxVoltage, velocity);
|
||||
}
|
||||
|
||||
/** The static gain. */
|
||||
const units::volt_t kS;
|
||||
|
||||
/** The velocity gain. */
|
||||
const units::unit_t<kv_unit> kV;
|
||||
|
||||
/** The acceleration gain. */
|
||||
const units::unit_t<ka_unit> kA;
|
||||
};
|
||||
} // namespace frc
|
||||
|
||||
Reference in New Issue
Block a user