robot_trajectory: Clarify meaning of dt with comments (moveit#302)

otamachan · Oct 20, 2016 · ba95291 · ba95291
1 parent 0a7a895
commit ba95291
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/moveit_core/robot_trajectory/include/moveit/robot_trajectory/robot_trajectory.h b/moveit_core/robot_trajectory/include/moveit/robot_trajectory/robot_trajectory.h
@@ -183,6 +183,11 @@ class RobotTrajectory
     duration_from_previous_.insert(duration_from_previous_.begin() + index, dt);
   }
 
+  /**
+   * \brief Add a trajectory to the end of the current trajectory
+   * \param source - the trajectory to append to the end of current trajectory
+   * \param dt - time step between last traj point in current traj, and first traj point of new traj
+   */
   void append(const RobotTrajectory &source, double dt);
 
   void swap(robot_trajectory::RobotTrajectory &other);