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.

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

Documentation for list_parameters #2315

Merged
merged 3 commits into from
Sep 27, 2023
Merged

Documentation for list_parameters #2315

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bafa72
list_parameters documentation
CursedRock17 Sep 26, 2023
a10be73
Better documentation
CursedRock17 Sep 27, 2023
69c75eb
Fixing Grammar
CursedRock17 Sep 27, 2023
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
6 changes: 5 additions & 1 deletion rclcpp/include/rclcpp/node.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,11 @@ class Node : public std::enable_shared_from_this<Node>

/// Return a list of parameters with any of the given prefixes, up to the given depth.
/**
* \todo: properly document and test this method.
* \param[in] prefixes The list of prefixes that should be searched for within the
* current parameters.
* \param[in] depth An unsigned integer that represents the recursive depth to search.
* \returns A ListParametersResult message which contains both an array of unique prefixes
* and an array of names that were matched to the prefixes given
*/
RCLCPP_PUBLIC
rcl_interfaces::msg::ListParametersResult
Expand Down