Parcourir la source

Update Functions Swift public API docs (#9145)

Paul Beusterien il y a 4 ans
Parent
commit
841bcd7c63

+ 9 - 6
FirebaseFunctionsSwift/Sources/Codable/Callable+Codable.swift

@@ -20,12 +20,14 @@ public extension Functions {
   /// Creates a reference to the Callable HTTPS trigger with the given name, the type of an `Encodable`
   /// request and the type of a `Decodable` response.
   /// - Parameter name: The name of the Callable HTTPS trigger
-  /// - Parameter requestType: The type of the `Encodable` entity to use for requests to this `Callable`
-  /// - Parameter responseType: The type of the `Decodable` entity to use for responses from this `Callable`
+  /// - Parameter requestAs: The type of the `Encodable` entity to use for requests to this `Callable`
+  /// - Parameter responseAs: The type of the `Decodable` entity to use for responses from this `Callable`
+  /// - Parameter encoder: The encoder instance to use to run the encoding.
+  /// - Parameter decoder: The decoder instance to use to run the decoding.
   func httpsCallable<Request: Encodable,
     Response: Decodable>(_ name: String,
-                         requestAs requestType: Request.Type = Request.self,
-                         responseAs responseType: Response.Type = Response.self,
+                         requestAs: Request.Type = Request.self,
+                         responseAs: Response.Type = Response.self,
                          encoder: FirebaseDataEncoder = FirebaseDataEncoder(),
                          decoder: FirebaseDataDecoder = FirebaseDataDecoder())
     -> Callable<Request, Response> {
@@ -139,9 +141,10 @@ public struct Callable<Request: Encodable, Response: Decodable> {
     /// resumes with a new FCM Token the next time you call this method.
     ///
     /// - Parameter data: The `Request` representing the data to pass to the trigger.
+    /// - Parameter encoder: The encoder instance to use to run the encoding.
+    /// - Parameter decoder: The decoder instance to use to run the decoding.
     ///
-    /// - Throws: An error if any value throws an error during encoding.
-    /// - Throws: An error if any value throws an error during decoding.
+    /// - Throws: An error if any value throws an error during encoding or decoding.
     /// - Throws: An error if the callable fails to complete
     ///
     /// - Returns: The decoded `Response` value