Skip to content

Commit

Permalink
Add doc block
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
  • Loading branch information
ivanpauno committed Apr 10, 2020
1 parent 7b4e246 commit 48651a1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions rclpy/src/rclpy/_rclpy.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down

0 comments on commit 48651a1

Please sign in to comment.