Skip to content

Improved the nav2_util::robot_utils.hpp documentation #5881

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.

Sign up for GitHub

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

Merged
SteveMacenski merged 2 commits into from
Jan 16, 2026
Merged

Improved the nav2_util::robot_utils.hpp documentation #5881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
562bfc7
Improved the documentation
delihus Jan 16, 2026
fe27fb5
Changed param description
delihus Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions nav2_util/include/nav2_util/robot_utils.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ namespace nav2_util
* @param tf_buffer TF buffer to use for the transformation
* @param global_frame Frame to transform into
* @param robot_frame Frame to transform from
* @param transform_timeout TF Timeout to use for transformation
* @param transform_timeout How long to wait for the target frame. When value is zero the functions does not block.
* @return bool Whether it could be transformed successfully
*/
bool getCurrentPose(
Expand All @@ -53,7 +53,7 @@ bool getCurrentPose(
* @param transformed_pose Output transformation
* @param tf_buffer TF buffer to use for the transformation
* @param target_frame Frame to transform into
* @param transform_timeout TF Timeout to use for transformation
* @param transform_timeout How long to wait for the target frame. When value is zero the functions does not block.
* @return bool Whether it could be transformed successfully
*/
bool transformPoseInTargetFrame(
Expand Down
Loading