From 48651a1cd0202243258952ba6ab0d715adc3b217 Mon Sep 17 00:00:00 2001 From: Ivan Santiago Paunovic Date: Fri, 10 Apr 2020 12:39:48 -0300 Subject: [PATCH] Add doc block Signed-off-by: Ivan Santiago Paunovic --- rclpy/src/rclpy/_rclpy.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/rclpy/src/rclpy/_rclpy.c b/rclpy/src/rclpy/_rclpy.c index 43f492bf4..ac0f6be85 100644 --- a/rclpy/src/rclpy/_rclpy.c +++ b/rclpy/src/rclpy/_rclpy.c @@ -3423,6 +3423,18 @@ rclpy_shutdown(PyObject * Py_UNUSED(self), PyObject * args) Py_RETURN_NONE; } +/// Get the list of nodes discovered by the provided node +/** + * Raises ValueError if pynode is not a node capsule + * Raises RuntimeError if there is an rcl error + * + * \param[in] args arguments tuple, composed by only one argument: + * - node: Capsule pointing to the node + * \param[in] use_security_contexts specifies if the output includes the security context or not + * \return Python list of tuples, containing: + * node name, node namespace, and + * security_context if `use_security_contexts` is true. + */ static PyObject * rclpy_get_node_names_impl(PyObject * args, bool use_security_contexts) {