From 02b01731cd358d7ae55c1c254b117da15e6f87ac Mon Sep 17 00:00:00 2001 From: Ayush Garg Date: Wed, 4 Mar 2020 01:54:15 -0500 Subject: [PATCH] Improve documentation for setJointPositions() (#1921) --- .../robot_state/include/moveit/robot_state/robot_state.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/moveit_core/robot_state/include/moveit/robot_state/robot_state.h b/moveit_core/robot_state/include/moveit/robot_state/robot_state.h index 7b88c738da..e70bb40e7c 100644 --- a/moveit_core/robot_state/include/moveit/robot_state/robot_state.h +++ b/moveit_core/robot_state/include/moveit/robot_state/robot_state.h @@ -520,7 +520,9 @@ class RobotState /** @} */ - /** \name Getting and setting joint positions, velocities, accelerations and effort + /** \name Getting and setting joint positions, velocities, accelerations and effort for a single joint + * The joint might be multi-DOF, i.e. require more than one variable to set. + * See setVariablePositions(), setVariableVelocities(), setVariableEffort() to handle multiple joints. * @{ */ void setJointPositions(const std::string& joint_name, const double* position)