From ac3fc4d50f63462ae6f29c424bae2b06064222fd Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 19 Jul 2021 12:07:00 -0700 Subject: [PATCH] fix documentation bug (#1719) (#1721) Signed-off-by: William Woodall (cherry picked from commit 86c079de3111631d8ae1a42eb40e1dd2f96c016f) Co-authored-by: William Woodall --- rclcpp/include/rclcpp/node.hpp | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/rclcpp/include/rclcpp/node.hpp b/rclcpp/include/rclcpp/node.hpp index 4a047b8..68272fe 100644 --- a/rclcpp/include/rclcpp/node.hpp +++ b/rclcpp/include/rclcpp/node.hpp @@ -892,12 +892,15 @@ public: std::map> 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>