Skip to content

Commit 5516d5f

Browse files
committed
Fix docstring for Servo smoothHalt function
1 parent d88d19f commit 5516d5f

File tree

1 file changed

+4
-2
lines changed
  • moveit_ros/moveit_servo/include/moveit_servo

1 file changed

+4
-2
lines changed

moveit_ros/moveit_servo/include/moveit_servo/servo.hpp

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ class Servo
113113

114114
/**
115115
* \brief Returns the most recent servo parameters.
116+
* @return The servo parameters.
116117
*/
117118
servo::Params& getParams();
118119

@@ -126,8 +127,9 @@ class Servo
126127

127128
/**
128129
* \brief Smoothly halt at a commanded state when command goes stale.
129-
* @param halt_state The desired stop state.
130-
* @return The next state stepping towards the required halting state.
130+
* @param halt_state The desired halting state.
131+
* @return A pair where the first element is a Boolean indicating whether the robot has stopped, and the second is a
132+
* state stepping towards the desired halting state.
131133
*/
132134
std::pair<bool, KinematicState> smoothHalt(const KinematicState& halt_state);
133135

0 commit comments

Comments
 (0)