Improve documentation for setJointPositions() (moveit#1921)

v4hn · Mar 31, 2020 · 02b0173 · 02b0173
1 parent e72f957
commit 02b0173
Showing 1 changed file with 3 additions and 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
@@ -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)