Skip to content

Commit f7395db

Browse files
committed
document new angular limit parameters in AckermannSteering.hh
Signed-off-by: Sikiru Salau <[email protected]>
1 parent a13e650 commit f7395db

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/systems/ackermann_steering/AckermannSteering.hh

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,17 @@ namespace systems
9292
/// element is optional, and the default value is 50Hz.
9393
///
9494
/// - `<min_velocity>`: Minimum velocity [m/s], usually <= 0.
95+
/// - `<min_angular_velocity>`: Minimum angular velocity [m/s], usually <= 0.
9596
/// - `<max_velocity>`: Maximum velocity [m/s], usually >= 0.
97+
/// - `<max_angular_velocity>`: Maximum angular velocity [m/s], usually >= 0.
9698
/// - `<min_acceleration>`: Minimum acceleration [m/s^2], usually <= 0.
99+
/// - `<min_angular_acceleration>`: Minimum angular acceleration [m/s^2], usually <= 0.
97100
/// - `<max_acceleration>`: Maximum acceleration [m/s^2], usually >= 0.
98-
/// - `<min_jerk Minimum>`: jerk [m/s^3], usually <= 0.
99-
/// - `<max_jerk Maximum>`: jerk [m/s^3], usually >= 0.
101+
/// - `<max_angular_acceleration>`: Maximum angular acceleration [m/s^2], usually >= 0.
102+
/// - `<min_jerk>`: Minimum jerk [m/s^3], usually <= 0.
103+
/// - `<min_angular_jerk>`: Minimum jerk [m/s^3], usually <= 0.
104+
/// - `<max_jerk>`: Maximum jerk [m/s^3], usually >= 0.
105+
/// - `<max_angular_jerk>`: Maximum jerk [m/s^3], usually >= 0.
100106
///
101107
/// - `<topic>`: Custom topic that this system will subscribe to in order to
102108
/// receive command messages. This element is optional, and the

0 commit comments

Comments
 (0)