From de582e1796f84ca90f93a79148cf9b100ddafeb0 Mon Sep 17 00:00:00 2001 From: Shane Loretz Date: Wed, 15 Dec 2021 09:29:33 -0800 Subject: [PATCH] Document until parameter Signed-off-by: Shane Loretz --- rclpy/src/rclpy/event.hpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rclpy/src/rclpy/event.hpp b/rclpy/src/rclpy/event.hpp index eea05cb01..a5fc936d1 100644 --- a/rclpy/src/rclpy/event.hpp +++ b/rclpy/src/rclpy/event.hpp @@ -40,6 +40,7 @@ class Event public: /// Wait until a time specified by a system or steady clock. /// \param clock the clock to use for time synchronization with until + /// \param until this method will block until this time is reached. template void wait_until(std::shared_ptr clock, rcl_time_point_t until); @@ -48,6 +49,7 @@ class Event /// the target ROS time is reached. /// when a given ROS time is reached. /// \param clock the clock to use for time synchronization. + /// \param until this method will block until this time is reached. void wait_until_ros(std::shared_ptr clock, rcl_time_point_t until); /// Indicate if the Event is set.