From 5ec7f18bdc2e7303edbe20e3a273f31904c7ff43 Mon Sep 17 00:00:00 2001 From: Gold856 <117957790+Gold856@users.noreply.github.com> Date: Sun, 23 Jul 2023 17:22:04 -0400 Subject: [PATCH] [wpilib] EventLoop docs: Remove BooleanEvent references (NFC) (#5463) --- wpilibc/src/main/native/include/frc/event/EventLoop.h | 6 +++--- .../main/java/edu/wpi/first/wpilibj/event/EventLoop.java | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/wpilibc/src/main/native/include/frc/event/EventLoop.h b/wpilibc/src/main/native/include/frc/event/EventLoop.h index d18fac3fe3..224dd3b545 100644 --- a/wpilibc/src/main/native/include/frc/event/EventLoop.h +++ b/wpilibc/src/main/native/include/frc/event/EventLoop.h @@ -10,8 +10,8 @@ #include namespace frc { -/** The loop polling BooleanEvent objects and executing the actions bound to - * them. */ +/** A declarative way to bind a set of actions to a loop and execute them when + * the loop is polled. */ class EventLoop { public: EventLoop(); @@ -20,7 +20,7 @@ class EventLoop { EventLoop& operator=(const EventLoop&) = delete; /** - * Bind a new action to run. + * Bind a new action to run when the loop is polled. * * @param action the action to run. */ diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/event/EventLoop.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/event/EventLoop.java index 3e92c019ab..3e220e06c2 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/event/EventLoop.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/event/EventLoop.java @@ -7,12 +7,14 @@ package edu.wpi.first.wpilibj.event; import java.util.Collection; import java.util.LinkedHashSet; -/** The loop polling {@link BooleanEvent} objects and executing the actions bound to them. */ +/** + * A declarative way to bind a set of actions to a loop and execute them when the loop is polled. + */ public final class EventLoop { private final Collection m_bindings = new LinkedHashSet<>(); /** - * Bind a new action to run whenever the condition is true. + * Bind a new action to run when the loop is polled. * * @param action the action to run. */