Address PR reviews

rapyuta-robotics · May 1, 2024 · 3ca3c08 · 3ca3c08
1 parent cac57b8
commit 3ca3c08
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/costmap_2d/include/costmap_2d/footprint.h b/costmap_2d/include/costmap_2d/footprint.h
@@ -120,6 +120,8 @@ bool makeFootprintFromString(const std::string& footprint_string, std::vector<ge
 /**
  * @brief Read the ros-params "footprint" and/or "robot_radius" from
  * the given NodeHandle using searchParam() to go up the tree.
+ * @return The footprint as a list of points and whether we used the robot_radius.
+ * I that's the case, the footprint will be a circle of "robot_radius".
  */
 std::pair<std::vector<geometry_msgs::Point>, bool> makeFootprintFromParams(ros::NodeHandle& nh);