From adecaa38e62bd3b51175ca3bf70fa78bdd40c023 Mon Sep 17 00:00:00 2001 From: Sikiru Salau Date: Thu, 30 Jan 2025 18:22:38 +0100 Subject: [PATCH] document new angular limit parameters in AckermannSteering.hh --- src/systems/ackermann_steering/AckermannSteering.hh | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/systems/ackermann_steering/AckermannSteering.hh b/src/systems/ackermann_steering/AckermannSteering.hh index 84583379c4..f5a3d9d658 100644 --- a/src/systems/ackermann_steering/AckermannSteering.hh +++ b/src/systems/ackermann_steering/AckermannSteering.hh @@ -92,11 +92,17 @@ namespace systems /// element is optional, and the default value is 50Hz. /// /// - ``: Minimum velocity [m/s], usually <= 0. + /// - ``: Minimum angular velocity [m/s], usually <= 0. /// - ``: Maximum velocity [m/s], usually >= 0. + /// - ``: Maximum angular velocity [m/s], usually >= 0. /// - ``: Minimum acceleration [m/s^2], usually <= 0. + /// - ``: Minimum angular acceleration [m/s^2], usually <= 0. /// - ``: Maximum acceleration [m/s^2], usually >= 0. - /// - ``: jerk [m/s^3], usually <= 0. - /// - ``: jerk [m/s^3], usually >= 0. + /// - ``: Maximum angular acceleration [m/s^2], usually >= 0. + /// - ``: Minimum jerk [m/s^3], usually <= 0. + /// - ``: Minimum jerk [m/s^3], usually <= 0. + /// - ``: Maximum jerk [m/s^3], usually >= 0. + /// - ``: Maximum jerk [m/s^3], usually >= 0. /// /// - ``: Custom topic that this system will subscribe to in order to /// receive command messages. This element is optional, and the