Skip to content

Commit

Permalink
fix documentation bug (#1719)
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodall <william@osrfoundation.org>
(cherry picked from commit 86c079d)
  • Loading branch information
wjwwood authored and mergify-bot committed Jul 16, 2021
1 parent 1fff1b7 commit 03e0fe5
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions rclcpp/include/rclcpp/node.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -892,12 +892,15 @@ class Node : public std::enable_shared_from_this<Node>
std::map<std::string, std::vector<std::string>>
get_service_names_and_types() const;

/// Return the number of publishers that are advertised on a given topic.
/// Return a map of existing service names to list of service types for a specific node.
/**
* \param[in] node_name the node_name on which to count the publishers.
* \param[in] namespace_ the namespace of the node associated with the name
* \return number of publishers that are advertised on a given topic.
* \throws std::runtime_error if publishers could not be counted
* This function only considers services - not clients.
* The returned names are the actual names used and do not have remap rules applied.
*
* \param[in] node_name name of the node.
* \param[in] namespace_ namespace of the node.
* \return a map of existing service names to list of service types.
* \throws std::runtime_error anything that rcl_error can throw.
*/
RCLCPP_PUBLIC
std::map<std::string, std::vector<std::string>>
Expand Down

0 comments on commit 03e0fe5

Please sign in to comment.