add comment

Signed-off-by: Soragna, Alberto <alberto.soragna@gmail.com>
mauropasse · Oct 19, 2020 · faf9d1e · faf9d1e
1 parent 1e0c24e
commit faf9d1e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/rclcpp/include/rclcpp/executors/events_executor_notify_waitable.hpp b/rclcpp/include/rclcpp/executors/events_executor_notify_waitable.hpp
@@ -25,6 +25,10 @@ namespace rclcpp
 namespace executors
 {
 
+/**
+ * @brief This class provides an EventWaitable that allows to
+ * wake up an EventsExecutor when a guard condition is notified.
+ */
 class EventsExecutorNotifyWaitable final : public EventWaitable
 {
 public: