chore: add public function docs

gtokman · May 5, 2021 · cfbfcf2 · cfbfcf2
1 parent fb657d9
commit cfbfcf2
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/Sources/ExtensionKit/CoreLocation/CLLocationManager.swift b/Sources/ExtensionKit/CoreLocation/CLLocationManager.swift
@@ -3,6 +3,11 @@ import CoreLocation
 
 public extension CLLocationManager {
 
+    /// Request locaton authorization and subscribe to `CLAuthorizationStatus` updates
+    /// - Parameters:
+    ///   - manager: `CLLocationManager`
+    ///   - type: `AuthorizationType`
+    /// - Returns: Publisher with `AuthorizationType`
     static func requestLocationAuthorization(
         with manager: CLLocationManager = .init(),
         type: AuthorizationType
@@ -11,6 +16,7 @@ public extension CLLocationManager {
             .eraseToAnyPublisher()
     }
 
+    /// Authorization access level
     enum AuthorizationType: String {
         case always, whenInUse
     }
@@ -61,7 +67,6 @@ final class AuthorizationSubscription <S: Subscriber>: NSObject,
     }
 }
 
-
 final class AuthorizationPublisher: NSObject, Publisher, CLLocationManagerDelegate, SubscriptionAuthorizationDelegate {
 
     typealias Output = CLAuthorizationStatus