docs: provide correct description for HIDEventReceiverClosure

Akazm · Dec 18, 2024 · d906dce · d906dce
1 parent f4f1b22
commit d906dce
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/Sources/TapGuard/HIDEventReceiver.swift b/Sources/TapGuard/HIDEventReceiver.swift
@@ -49,9 +49,8 @@ public protocol DisposableHIDEventReceiver: Sendable {
     var remove: @Sendable () -> Void { get }
 }
 
-/// Wraps a closure acting as a ``HIDEventDispatcher``
-///
-/// See also: ``HIDEventReceiver``
+/// Encapsulates a closure - conforming to either ``HIDEventProcessor/sync(_:)`` or ``HIDEventProcessor/async(_:)`` argument signature -
+/// in a ``HIDEventReceiver``
 public final class HIDEventReceiverClosure: DisposableHIDEventReceiver, MutableHIDEventReceiver {
     private let eventReceiverPriority: AllocatedUnfairLock<UInt64> = .init(initialState: .init(UInt32.max))
     private let eventReceiverEnabled: AllocatedUnfairLock<Bool> = .init(initialState: true)