Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incorrect doxygen comment in costmap_2d #4741

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

Ryanf55
Copy link
Contributor

@Ryanf55 Ryanf55 commented Nov 6, 2024

Description of contribution in a few bullet points

  • Fix incorrect doxygen comment naming params that don't exist.

For Maintainers:

  • Check that any new parameters added are updated in docs.nav2.org
  • Check that any significant change is added to the migration guide
  • Check that any new features OR changes to existing behaviors are reflected in the tuning guide
  • Check that any new functions have Doxygen added
  • Check that any new features have test coverage
  • Check that any new plugins is added to the plugins page
  • If BT Node, Additionally: add to BT's XML index of nodes for groot, BT package's readme table, and BT library lists

Signed-off-by: Ryan Friedman <[email protected]>
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
..._costmap_2d/include/nav2_costmap_2d/costmap_2d.hpp 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

@SteveMacenski SteveMacenski merged commit be73c24 into ros-navigation:main Nov 6, 2024
11 checks passed
@Ryanf55 Ryanf55 deleted the fix-doxygen branch November 6, 2024 15:49
SteveMacenski pushed a commit that referenced this pull request Nov 8, 2024
SteveMacenski pushed a commit that referenced this pull request Nov 8, 2024
SteveMacenski added a commit that referenced this pull request Nov 8, 2024
* [DWB] Option to limit velocity commands in trajectory generator (#4663)

* Option to limit vel cmd through traj generator

Signed-off-by: huiyulhy <[email protected]>

* Cleanup

Signed-off-by: huiyulhy <[email protected]>

* fix linting

Signed-off-by: huiyulhy <[email protected]>

* Update linting

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>

* fix to bt action server logging before bt execution result being ready (#4677)

Signed-off-by: DreamWest <[email protected]>

* fix(simple-action-server): info log instead of warn on cancel (#4684)

Cancelling a goal is nominal behavior and therefore it should not log
warning.

Signed-off-by: Rein Appeldoorn <[email protected]>

* [RotationShimController] fix: rotate to goal heading (#4724)

Add frame_id to goal when rotating towards goal heading, otherwise the
transform would fail. This bug was introduced in 30e2cde by not setting
the frame_id.

Signed-off-by: agennart <[email protected]>
Co-authored-by: agennart <[email protected]>

* Fix incorrect doxygen comment (#4741)

Signed-off-by: Ryan Friedman <[email protected]>

* [map_io] Replace std logs by rclcpp logs (#4720)

* replace std logs by rclcpp logs

Signed-off-by: Guillaume Doisy <[email protected]>

* RCLCPP_DEBUG to RCLCPP_INFO for visibility

Signed-off-by: Guillaume Doisy <[email protected]>

---------

Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>

* bump to 1.1.17 for humble sync

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>
Signed-off-by: DreamWest <[email protected]>
Signed-off-by: Rein Appeldoorn <[email protected]>
Signed-off-by: agennart <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Guillaume Doisy <[email protected]>
Signed-off-by: Steve Macenski <[email protected]>
Co-authored-by: Huiyu Leong <[email protected]>
Co-authored-by: DreamWest <[email protected]>
Co-authored-by: Rein Appeldoorn <[email protected]>
Co-authored-by: Saitama <[email protected]>
Co-authored-by: agennart <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
SteveMacenski added a commit that referenced this pull request Nov 8, 2024
* Adding non-charging dock support to docking server (for conveyers, pallots, etc) (#4627)

* adding non-charging dock support to docking server

Signed-off-by: Steve Macenski <[email protected]>

* docs and linting

* adding unit tests

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>

* Publish optimal trajectory as a Path message (#4640)

* Publish optimal trajectory as a Path message

Signed-off-by: Alyssa Agnissan <[email protected]>

* move publish_optimal_path to TrajectoryVisualizer + minor refactoring

Signed-off-by: Alyssa Agnissan <[email protected]>

* tests added for optimal path publication

Signed-off-by: Alyssa Agnissan <[email protected]>

* populate optimal path message in add()

Signed-off-by: Alyssa Agnissan <[email protected]>

* move path population in add_marker

Signed-off-by: Alyssa Agnissan <[email protected]>

---------

Signed-off-by: Alyssa Agnissan <[email protected]>

* [collision monitor] Select the observation sources used with each polygon (#4227)

* Collision monitor: select specific observation sources for polygon

Signed-off-by: asarazin <[email protected]>

* optimization

Signed-off-by: asarazin <[email protected]>

* add tests

Signed-off-by: asarazin <[email protected]>

---------

Signed-off-by: asarazin <[email protected]>
Co-authored-by: asarazin <[email protected]>

* Restore exported BT test utils header files after cmake revamp (#4652) (#4654)

Signed-off-by: Mike Wake <[email protected]>

* fix(bt_nodes): Correct default `server_timeout` behavior by using `getInputPortOrBlackboard()` (#4649)

Signed-off-by: Alan Xue <[email protected]>

* PoseStamped vector specialization (#4607)

* PoseStamped vector specialization

Signed-off-by: Tony Najjar <[email protected]>

* merge master

Signed-off-by: Tony Najjar <[email protected]>

* add path

Signed-off-by: Tony Najjar <[email protected]>

* fix size check

Signed-off-by: Tony Najjar <[email protected]>

* fix test

Signed-off-by: Tony Najjar <[email protected]>

* Revert "fix test"

This reverts commit 51f54eb.

* fix test

Signed-off-by: Tony Najjar <[email protected]>

---------

Signed-off-by: Tony Najjar <[email protected]>

* [DWB] Option to limit velocity commands in trajectory generator (#4663)

* Option to limit vel cmd through traj generator

Signed-off-by: huiyulhy <[email protected]>

* Cleanup

Signed-off-by: huiyulhy <[email protected]>

* fix linting

Signed-off-by: huiyulhy <[email protected]>

* Update linting

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>

* Adding planner server timeout for costmap waiting (#4673)

* Adding planner server timeout for costmap waiting

Signed-off-by: Steve Macenski <[email protected]>

* Adding controller server's costmap timeout as well

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>

* fixing path longer on approach (#4622)

* fixing path longer on approach

Signed-off-by: Pradheep <[email protected]>

* removing the short circuit

Signed-off-by: Pradheep <[email protected]>

* adding additional layer of check

Signed-off-by: Pradheep <[email protected]>

---------

Signed-off-by: Pradheep <[email protected]>

* fix to bt action server logging before bt execution result being ready (#4677)

Signed-off-by: DreamWest <[email protected]>

* Correct paper name for graceful controller

Signed-off-by: Steve Macenski <[email protected]>

* Added missing action clients in robot_navigator(BasicNavigator) to destroy_node (#4698)

* fix: added assisted_teleop_client to robot_navigator(BasicNavigator) destroy_node

Signed-off-by: Tiwa Ojo <[email protected]>

* fix: added other missing action clients to robot_navigator(BasicNavigator) destroy_node

Signed-off-by: Tiwa Ojo <[email protected]>

---------

Signed-off-by: Tiwa Ojo <[email protected]>

* Fixing SGF in MPPI and Smoother (#4669)

Signed-off-by: Steve Macenski <[email protected]>

* fix: handle transition failures in all servers (#4708)

* fix: handle transition failures in planner/controller/smoother servers

Signed-off-by: Kemal Bektas <[email protected]>

* adding support for rest of servers + review comments

Signed-off-by: Steve Macenski <[email protected]>

* Replacing throws with error and failed lifecycle transitions

Signed-off-by: Steve Macenski <[email protected]>

* fix vel smoother unit tests

Signed-off-by: Steve Macenski <[email protected]>

* fixing docking server unit testing

Signed-off-by: Steve Macenski <[email protected]>

* fixing last bits

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Kemal Bektas <[email protected]>
Signed-off-by: Steve Macenski <[email protected]>
Co-authored-by: Kemal Bektas <[email protected]>

* [RotationShimController] fix: rotate on short paths (#4716)

Add header data to goal for short paths.

Commit d8ae3c1 added the possibility to
the rotation shim controller to rotate towards the goal when the goal
was closer that the `forward_sampling_distance`. This feature was not
fully working as the goal was missing proper header data, causing the
rotation shim to give back control to the main controller.

Co-authored-by: agennart <[email protected]>

* Added parameter `rotate_to_heading_once` (#4721)

Signed-off-by: Daniil Khaninaev <[email protected]>

* [RotationShimController] fix: rotate to goal heading (#4724)

Add frame_id to goal when rotating towards goal heading, otherwise the
transform would fail. This bug was introduced in 30e2cde by not setting
the frame_id.

Signed-off-by: agennart <[email protected]>
Co-authored-by: agennart <[email protected]>

* [loopback_sim] Publish clock, [nav2_costmap_2d] Fix Qos (#4726)

* Publish /clock from loopback sim

Signed-off-by: Adi Vardi <[email protected]>

* [nav2_costmap_2d] Fix obstacle_layer trying to use RELIABLE QoS

Use QoS profile from rclcpp::SensorDataQoS() instead of rmw_qos_profile_t.
This solves an issue where the subscriber uses RELIABLE setting even when initialized from rmw_qos_profile_sensor_data.
In addition the Subscriber(..., rmw_qos_profile_t) constructor is deprecated in favor of Subscriber(..., rclcpp::QoS)

Signed-off-by: Adi Vardi <[email protected]>

* [nav2_smac_planner] fix typos

Signed-off-by: Adi Vardi <[email protected]>

* Use single quotes

Signed-off-by: Adi Vardi <[email protected]>

---------

Signed-off-by: Adi Vardi <[email protected]>

* Fix incorrect doxygen comment (#4741)

Signed-off-by: Ryan Friedman <[email protected]>

* Updating error logging in Smac collision detector object (#4743)

* Updating error logging in Smac configs

Signed-off-by: Steve Macenski <[email protected]>

* linting

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>

* [map_io] Replace std logs by rclcpp logs (#4720)

* replace std logs by rclcpp logs

Signed-off-by: Guillaume Doisy <[email protected]>

* RCLCPP_DEBUG to RCLCPP_INFO for visibility

Signed-off-by: Guillaume Doisy <[email protected]>

---------

Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>

* manual backport to Jazzy of 6b2e244

Signed-off-by: Steve Macenski <[email protected]>

* bump to 1.3.3 for jazzy sync

Signed-off-by: Steve Macenski <[email protected]>

* fixing backport issue

Signed-off-by: Steve Macenski <[email protected]>

* fixing backport of docking linking changes

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>
Signed-off-by: Alyssa Agnissan <[email protected]>
Signed-off-by: asarazin <[email protected]>
Signed-off-by: Mike Wake <[email protected]>
Signed-off-by: Alan Xue <[email protected]>
Signed-off-by: Tony Najjar <[email protected]>
Signed-off-by: huiyulhy <[email protected]>
Signed-off-by: Pradheep <[email protected]>
Signed-off-by: DreamWest <[email protected]>
Signed-off-by: Tiwa Ojo <[email protected]>
Signed-off-by: Kemal Bektas <[email protected]>
Signed-off-by: Daniil Khaninaev <[email protected]>
Signed-off-by: agennart <[email protected]>
Signed-off-by: Adi Vardi <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: alyquantillion <[email protected]>
Co-authored-by: anaelle-sw <[email protected]>
Co-authored-by: asarazin <[email protected]>
Co-authored-by: aosmw <[email protected]>
Co-authored-by: Alan <[email protected]>
Co-authored-by: Tony Najjar <[email protected]>
Co-authored-by: Huiyu Leong <[email protected]>
Co-authored-by: Pradheep Krishna <[email protected]>
Co-authored-by: DreamWest <[email protected]>
Co-authored-by: Tiwa Ojo <[email protected]>
Co-authored-by: Kemal Bektas <[email protected]>
Co-authored-by: Saitama <[email protected]>
Co-authored-by: agennart <[email protected]>
Co-authored-by: Daniil Khaninaev <[email protected]>
Co-authored-by: Adi Vardi <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
RBT22 pushed a commit to EnjoyRobotics/navigation2 that referenced this pull request Nov 11, 2024
* [DWB] Option to limit velocity commands in trajectory generator (ros-navigation#4663)

* Option to limit vel cmd through traj generator

Signed-off-by: huiyulhy <[email protected]>

* Cleanup

Signed-off-by: huiyulhy <[email protected]>

* fix linting

Signed-off-by: huiyulhy <[email protected]>

* Update linting

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>

* fix to bt action server logging before bt execution result being ready (ros-navigation#4677)

Signed-off-by: DreamWest <[email protected]>

* fix(simple-action-server): info log instead of warn on cancel (ros-navigation#4684)

Cancelling a goal is nominal behavior and therefore it should not log
warning.

Signed-off-by: Rein Appeldoorn <[email protected]>

* [RotationShimController] fix: rotate to goal heading (ros-navigation#4724)

Add frame_id to goal when rotating towards goal heading, otherwise the
transform would fail. This bug was introduced in 30e2cde by not setting
the frame_id.

Signed-off-by: agennart <[email protected]>
Co-authored-by: agennart <[email protected]>

* Fix incorrect doxygen comment (ros-navigation#4741)

Signed-off-by: Ryan Friedman <[email protected]>

* [map_io] Replace std logs by rclcpp logs (ros-navigation#4720)

* replace std logs by rclcpp logs

Signed-off-by: Guillaume Doisy <[email protected]>

* RCLCPP_DEBUG to RCLCPP_INFO for visibility

Signed-off-by: Guillaume Doisy <[email protected]>

---------

Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>

* bump to 1.1.17 for humble sync

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>
Signed-off-by: DreamWest <[email protected]>
Signed-off-by: Rein Appeldoorn <[email protected]>
Signed-off-by: agennart <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Guillaume Doisy <[email protected]>
Signed-off-by: Steve Macenski <[email protected]>
Co-authored-by: Huiyu Leong <[email protected]>
Co-authored-by: DreamWest <[email protected]>
Co-authored-by: Rein Appeldoorn <[email protected]>
Co-authored-by: Saitama <[email protected]>
Co-authored-by: agennart <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
emilnovak pushed a commit to EnjoyRobotics/navigation2 that referenced this pull request Nov 12, 2024
* Adding disengagement threshold to rotation shim controller (backport ros-navigation#4699) (ros-navigation#4702)

* Adding disengagement threshold to rotation shim controller (ros-navigation#4699)

* adding disengagement threshold to rotation shim controller

Signed-off-by: Steve Macenski <[email protected]>

* change default to 22.5 deg

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>
(cherry picked from commit fc7e086)

* Update nav2_rotation_shim_controller/src/nav2_rotation_shim_controller.cpp

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>
Co-authored-by: Steve Macenski <[email protected]>

* fix(nav2_theta_star_planner) Fix crash on Humble when goal is outside map bounds (ros-navigation#4706)

* Humble sync 13: Nov 8, 2024 (ros-navigation#4748)

* [DWB] Option to limit velocity commands in trajectory generator (ros-navigation#4663)

* Option to limit vel cmd through traj generator

Signed-off-by: huiyulhy <[email protected]>

* Cleanup

Signed-off-by: huiyulhy <[email protected]>

* fix linting

Signed-off-by: huiyulhy <[email protected]>

* Update linting

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

* uncrustify

Signed-off-by: huiyulhy <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>

* fix to bt action server logging before bt execution result being ready (ros-navigation#4677)

Signed-off-by: DreamWest <[email protected]>

* fix(simple-action-server): info log instead of warn on cancel (ros-navigation#4684)

Cancelling a goal is nominal behavior and therefore it should not log
warning.

Signed-off-by: Rein Appeldoorn <[email protected]>

* [RotationShimController] fix: rotate to goal heading (ros-navigation#4724)

Add frame_id to goal when rotating towards goal heading, otherwise the
transform would fail. This bug was introduced in 30e2cde by not setting
the frame_id.

Signed-off-by: agennart <[email protected]>
Co-authored-by: agennart <[email protected]>

* Fix incorrect doxygen comment (ros-navigation#4741)

Signed-off-by: Ryan Friedman <[email protected]>

* [map_io] Replace std logs by rclcpp logs (ros-navigation#4720)

* replace std logs by rclcpp logs

Signed-off-by: Guillaume Doisy <[email protected]>

* RCLCPP_DEBUG to RCLCPP_INFO for visibility

Signed-off-by: Guillaume Doisy <[email protected]>

---------

Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>

* bump to 1.1.17 for humble sync

Signed-off-by: Steve Macenski <[email protected]>

---------

Signed-off-by: huiyulhy <[email protected]>
Signed-off-by: DreamWest <[email protected]>
Signed-off-by: Rein Appeldoorn <[email protected]>
Signed-off-by: agennart <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Guillaume Doisy <[email protected]>
Signed-off-by: Steve Macenski <[email protected]>
Co-authored-by: Huiyu Leong <[email protected]>
Co-authored-by: DreamWest <[email protected]>
Co-authored-by: Rein Appeldoorn <[email protected]>
Co-authored-by: Saitama <[email protected]>
Co-authored-by: agennart <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>

---------

Signed-off-by: Steve Macenski <[email protected]>
Signed-off-by: huiyulhy <[email protected]>
Signed-off-by: DreamWest <[email protected]>
Signed-off-by: Rein Appeldoorn <[email protected]>
Signed-off-by: agennart <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Guillaume Doisy <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Steve Macenski <[email protected]>
Co-authored-by: brayanpa <[email protected]>
Co-authored-by: Huiyu Leong <[email protected]>
Co-authored-by: DreamWest <[email protected]>
Co-authored-by: Rein Appeldoorn <[email protected]>
Co-authored-by: Saitama <[email protected]>
Co-authored-by: agennart <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Co-authored-by: Guillaume Doisy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants