Merge pull request #100 from RxSwiftCommunity/feature/docsFromReadme

Add documentation for RxGestureRecognizerDelegate properties
RxSwiftCommunity · Aug 19, 2019 · bd13354 · bd13354
2 parents 5324363 + 4ee1d6f
commit bd13354
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Pod/Classes/RxGestureRecognizerDelegate.swift b/Pod/Classes/RxGestureRecognizerDelegate.swift
@@ -55,21 +55,27 @@ public struct GestureRecognizerDelegatePolicy<PolicyInput> {
 
 public final class RxGestureRecognizerDelegate: NSObject, GestureRecognizerDelegate {
 
+    /// Corresponding delegate method: gestureRecognizerShouldBegin(:_)
     public var beginPolicy: GestureRecognizerDelegatePolicy<GestureRecognizer> = .always
 
+    /// Corresponding delegate method: gestureRecognizer(_:shouldReceive:)
     public var touchReceptionPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, Touch)> = .always
 
+    /// Corresponding delegate method: gestureRecognizer(_:shouldBeRequiredToFailBy:)
     public var selfFailureRequirementPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, GestureRecognizer)> = .never
 
+    /// Corresponding delegate method: gestureRecognizer(_:shouldRequireFailureOf:)
     public var otherFailureRequirementPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, GestureRecognizer)> = .never
 
+    /// Corresponding delegate method: gestureRecognizer(_:shouldRecognizeSimultaneouslyWith:)
     public var simultaneousRecognitionPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, GestureRecognizer)> = .always
 
     #if os(iOS)
     // Workaround because we can't have stored properties with @available annotation
     private var _pressReceptionPolicy: Any?
 
     @available(iOS 9.0, *)
+    /// Corresponding delegate method: gestureRecognizer(_:shouldReceive:)
     public var pressReceptionPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, UIPress)> {
         get {
             if let policy = _pressReceptionPolicy as? GestureRecognizerDelegatePolicy<(GestureRecognizer, UIPress)> {
@@ -84,6 +90,7 @@ public final class RxGestureRecognizerDelegate: NSObject, GestureRecognizerDeleg
     #endif
 
     #if os(OSX)
+    /// Corresponding delegate method: gestureRecognizer(_:shouldAttemptToRecognizeWith:)
     public var eventRecognitionAttemptPolicy: GestureRecognizerDelegatePolicy<(GestureRecognizer, NSEvent)> = .always
     #endif