firebase
diff --git a/‎FirebaseFunctions/Sources/Functions.swift
Lines changed: 28 additions & 17 deletions b/‎FirebaseFunctions/Sources/Functions.swift
Lines changed: 28 additions & 17 deletions
diff --git a/‎FirebaseFunctions/Sources/FunctionsError.swift
Lines changed: 3 additions & 3 deletions b/‎FirebaseFunctions/Sources/FunctionsError.swift
Lines changed: 3 additions & 3 deletions
diff --git a/‎FirebaseFunctions/Sources/HTTPSCallable.swift
Lines changed: 16 additions & 14 deletions b/‎FirebaseFunctions/Sources/HTTPSCallable.swift
Lines changed: 16 additions & 14 deletions
diff --git a/‎FirebaseStorage/Sources/AsyncAwait.swift
Lines changed: 18 additions & 3 deletions b/‎FirebaseStorage/Sources/AsyncAwait.swift
Lines changed: 18 additions & 3 deletions
@@ -44,28 +44,29 @@ internal enum FunctionsConstants {
 
   /// The network client to use for http requests.
   private let fetcherService: GTMSessionFetcherService
-  // The projectID to use for all function references.
+  /// The projectID to use for all function references.
   private let projectID: String
-  // A serializer to encode/decode data and return values.
+  /// A serializer to encode/decode data and return values.
   private let serializer = FUNSerializer()
-  // A factory for getting the metadata to include with function calls.
+  /// A factory for getting the metadata to include with function calls.
   private let contextProvider: FunctionsContextProvider
 
-  // The custom domain to use for all functions references (optional).
+  /// The custom domain to use for all functions references (optional).
   internal let customDomain: String?
 
-  // The region to use for all function references.
+  /// The region to use for all function references.
   internal let region: String
 
   // MARK: - Public APIs
 
   /**
-   * The current emulator origin, or nil if it is not set.
+   * The current emulator origin, or `nil` if it is not set.
    */
   open private(set) var emulatorOrigin: String?
 
   /**
-   * Creates a Cloud Functions client or returns a pre-existing instance if it already exists.
+   * Creates a Cloud Functions client using the default or returns a pre-existing instance if it already exists.
+   * - Returns: A shared Functions instance initialized with the default `FirebaseApp`.
    */
   @objc(functions) open class func functions() -> Functions {
     return functions(
@@ -78,15 +79,17 @@ internal enum FunctionsConstants {
   /**
    * Creates a Cloud Functions client with the given app, or returns a pre-existing
    * instance if one already exists.
-   * @param app The app for the Firebase project.
+   * - Parameter app The app for the Firebase project.
+   * - Returns: A shared Functions instance initialized with the specified `FirebaseApp`.
    */
   @objc(functionsForApp:) open class func functions(app: FirebaseApp) -> Functions {
     return functions(app: app, region: FunctionsConstants.defaultRegion, customDomain: nil)
   }
 
   /**
    * Creates a Cloud Functions client with the default app and given region.
-   * @param region The region for the http trigger, such as "us-central1".
+   * - Parameter region The region for the HTTP trigger, such as `us-central1`.
+   * - Returns: A shared Functions instance initialized with the default `FirebaseApp` and a custom region.
    */
   @objc(functionsForRegion:) open class func functions(region: String) -> Functions {
     return functions(app: FirebaseApp.app(), region: region, customDomain: nil)
@@ -95,7 +98,8 @@ internal enum FunctionsConstants {
   /**
    * Creates a Cloud Functions client with the given app and region, or returns a pre-existing
    * instance if one already exists.
-   * @param customDomain A custom domain for the http trigger, such as "https://mydomain.com".
+   * - Parameter customDomain A custom domain for the HTTP trigger, such as "https://mydomain.com".
+   * - Returns: A shared Functions instance initialized with the default `FirebaseApp` and a custom HTTP trigger domain.
    */
   @objc(functionsForCustomDomain:) open class func functions(customDomain: String) -> Functions {
     return functions(app: FirebaseApp.app(),
@@ -105,8 +109,10 @@ internal enum FunctionsConstants {
   /**
    * Creates a Cloud Functions client with the given app and region, or returns a pre-existing
    * instance if one already exists.
-   * @param app The app for the Firebase project.
-   * @param region The region for the http trigger, such as "us-central1".
+   * - Parameters:
+   *   - app: The app for the Firebase project.
+   *   - region: The region for the HTTP trigger, such as `us-central1`.
+   * - Returns: An instance of `Functions` with a custom app and region.
    */
   @objc(functionsForApp:region:) open class func functions(app: FirebaseApp,
                                                            region: String) -> Functions {
@@ -116,8 +122,10 @@ internal enum FunctionsConstants {
   /**
    * Creates a Cloud Functions client with the given app and region, or returns a pre-existing
    * instance if one already exists.
-   * @param app The app for the Firebase project.
-   * @param customDomain A custom domain for the http trigger, such as "https://mydomain.com".
+   * - Parameters:
+   *   - app The app for the Firebase project.
+   *   - customDomain A custom domain for the HTTP trigger, such as `https://mydomain.com`.
+   * - Returns: An instance of `Functions` with a custom app and HTTP trigger domain.
    */
   @objc(functionsForApp:customDomain:) open class func functions(app: FirebaseApp,
                                                                  customDomain: String)
@@ -127,7 +135,7 @@ internal enum FunctionsConstants {
 
   /**
    * Creates a reference to the Callable HTTPS trigger with the given name.
-   * @param name The name of the Callable HTTPS trigger.
+   * - Parameter name The name of the Callable HTTPS trigger.
    */
   @objc(HTTPSCallableWithName:) open func httpsCallable(_ name: String) -> HTTPSCallable {
     return HTTPSCallable(functions: self, name: name)
@@ -144,6 +152,7 @@ internal enum FunctionsConstants {
   /// - 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.
+  /// - Returns: A reference to an HTTPS-callable Cloud Function that can be used to make Cloud Functions invocations.
   open func httpsCallable<Request: Encodable,
     Response: Decodable>(_ name: String,
                          requestAs: Request.Type = Request.self,
@@ -163,6 +172,7 @@ internal enum FunctionsConstants {
   /// - 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.
+  /// - Returns: A reference to an HTTPS-callable Cloud Function that can be used to make Cloud Functions invocations.
   open func httpsCallable<Request: Encodable,
     Response: Decodable>(_ url: URL,
                          requestAs: Request.Type = Request.self,
@@ -178,8 +188,9 @@ internal enum FunctionsConstants {
   /**
    * Changes this instance to point to a Cloud Functions emulator running locally.
    * See https://firebase.google.com/docs/functions/local-emulator
-   * @param host The host of the local emulator, such as "localhost".
-   * @param port The port of the local emulator, for example 5005.
+   * - Parameters:
+   *   - host: The host of the local emulator, such as "localhost".
+   *   - port: The port of the local emulator, for example 5005.
    */
   @objc open func useEmulator(withHost host: String, port: Int) {
     let prefix = host.hasPrefix("http") ? "" : "http://"
 
@@ -102,11 +102,11 @@ public let FunctionsErrorDetailsKey: String = "details"
 }
 
 /**
- * Takes an HTTP status code and returns the corresponding FIRFunctionsErrorCode error code.
+ * Takes an HTTP status code and returns the corresponding `FIRFunctionsErrorCode` error code.
  * This is the standard HTTP status code -> error mapping defined in:
  * https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
- * @param status An HTTP status code.
- * @return The corresponding error code, or FIRFunctionsErrorCodeUnknown if none.
+ * - Parameter status An HTTP status code.
+ * - Returns: The corresponding error code, or `FIRFunctionsErrorCodeUnknown` if none.
  */
 internal func FunctionsCodeForHTTPStatus(_ status: NSInteger) -> FunctionsErrorCode {
   switch status {
 
@@ -23,8 +23,8 @@ open class HTTPSCallableResult: NSObject {
    * The data that was returned from the Callable HTTPS trigger.
    *
    * The data is in the form of native objects. For example, if your trigger returned an
-   * array, this object would be an NSArray. If your trigger returned a JavaScript object with
-   * keys and values, this object would be an NSDictionary.
+   * array, this object would be an `Array<Any>`. If your trigger returned a JavaScript object with
+   * keys and values, this object would be an instance of `[String: Any]`.
    */
   @objc public let data: Any
 
@@ -34,7 +34,7 @@ open class HTTPSCallableResult: NSObject {
 }
 
 /**
- * A `HTTPSCallable` is reference to a particular Callable HTTPS trigger in Cloud Functions.
+ * A `HTTPSCallable` is a reference to a particular Callable HTTPS trigger in Cloud Functions.
  */
 @objc(FIRHTTPSCallable)
 open class HTTPSCallable: NSObject {
@@ -71,11 +71,11 @@ open class HTTPSCallable: NSObject {
    * Executes this Callable HTTPS trigger asynchronously.
    *
    * The data passed into the trigger can be any of the following types:
-   * * NSNull
-   * * NSString
-   * * NSNumber
-   * * NSArray<id>, where the contained objects are also one of these types.
-   * * NSDictionary<NSString, id>, where the values are also one of these types.
+   * - `nil` or `NSNull`
+   * - `String`
+   * - `NSNumber`, or any Swift numeric type bridgeable to `NSNumber`
+   * - `[Any]`, where the contained objects are also one of these types.
+   * - `[String: Any]` where the values are also one of these types.
    *
    * The request to the Cloud Functions backend made by this method automatically includes a
    * Firebase Installations ID token to identify the app instance. If a user is logged in with
@@ -85,8 +85,9 @@ open class HTTPSCallable: NSObject {
    * regarding the app instance. To stop this, see `Messaging.deleteData()`. It
    * resumes with a new FCM Token the next time you call this method.
    *
-   * @param data Parameters to pass to the trigger.
-   * @param completion The block to call when the HTTPS request has completed.
+   * - Parameters:
+   *   - data: Parameters to pass to the trigger.
+   *   - completion: The block to call when the HTTPS request has completed.
    */
   @objc(callWithObject:completion:) open func call(_ data: Any? = nil,
                                                    completion: @escaping (HTTPSCallableResult?,
@@ -115,7 +116,7 @@ open class HTTPSCallable: NSObject {
   }
 
   /**
-   * Executes this Callable HTTPS trigger asynchronously. This API should only be used from Objective C
+   * Executes this Callable HTTPS trigger asynchronously. This API should only be used from Objective-C.
    *
    * The request to the Cloud Functions backend made by this method automatically includes a
    * Firebase Installations ID token to identify the app instance. If a user is logged in with
@@ -125,7 +126,7 @@ open class HTTPSCallable: NSObject {
    * regarding the app instance. To stop this, see `Messaging.deleteData()`. It
    * resumes with a new FCM Token the next time you call this method.
    *
-   * @param completion The block to call when the HTTPS request has completed.
+   * - Parameter completion The block to call when the HTTPS request has completed.
    */
   @objc(callWithCompletion:) public func __call(completion: @escaping (HTTPSCallableResult?,
                                                                        Error?) -> Void) {
@@ -144,8 +145,9 @@ open class HTTPSCallable: NSObject {
      * regarding the app instance. To stop this, see `Messaging.deleteData()`. It
      * resumes with a new FCM Token the next time you call this method.
      *
-     * @param data Parameters to pass to the trigger.
-     * @returns The result of the call.
+     * - Parameter data Parameters to pass to the trigger.
+     * - Throws: An error if the Cloud Functions invocation failed.
+     * - Returns: The result of the call.
      */
     @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
     open func call(_ data: Any? = nil) async throws -> HTTPSCallableResult {
 
@@ -25,6 +25,8 @@ import Foundation
     /// - Parameters:
     ///   - size: The maximum size in bytes to download. If the download exceeds this size,
     ///           the task will be cancelled and an error will be thrown.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if the data exceeded `maxSize`.
     /// - Returns: Data object.
     func data(maxSize: Int64) async throws -> Data {
       return try await withCheckedThrowingContinuation { continuation in
@@ -43,6 +45,8 @@ import Foundation
     ///   - uploadData: The Data to upload.
     ///   - metadata: Optional StorageMetadata containing additional information (MIME type, etc.)
     ///              about the object being uploaded.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if Storage was unreachable.
     /// - Returns: StorageMetadata with additional information about the object being uploaded.
     func putDataAsync(_ uploadData: Data,
                       metadata: StorageMetadata? = nil) async throws -> StorageMetadata {
@@ -60,7 +64,9 @@ import Foundation
     ///   - url: A URL representing the system file path of the object to be uploaded.
     ///   - metadata: Optional StorageMetadata containing additional information (MIME type, etc.)
     ///              about the object being uploaded.
-    /// - Returns: StorageMetadata with additional information about the object being uploaded.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if no file was present at the specified `url`.
+    /// - Returns: `StorageMetadata` with additional information about the object being uploaded.
     func putFileAsync(from url: URL,
                       metadata: StorageMetadata? = nil) async throws -> StorageMetadata {
       return try await withCheckedThrowingContinuation { continuation in
@@ -75,7 +81,10 @@ import Foundation
     ///
     /// - Parameters:
     ///   - fileUrl: A URL representing the system file path of the object to be uploaded.
-    /// - Returns: URL pointing to the file path of the downloaded file.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if Storage was unreachable
+    ///   or `fileURL` did not reference a valid path on disk.
+    /// - Returns: A `URL` pointing to the file path of the downloaded file.
     func writeAsync(toFile fileURL: URL) async throws -> URL {
       return try await withCheckedThrowingContinuation { continuation in
         // TODO: Use task to handle progress and cancellation.
@@ -96,8 +105,11 @@ import Foundation
     /// - Parameters:
     ///   - maxResults The maximum number of results to return in a single page. Must be
     ///                greater than 0 and at most 1000.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if Storage was unreachable
+    ///   or the storage reference referenced an invalid path.
     /// - Returns:
-    ///   - completion A `Result` enum with either the list or an `Error`.
+    ///   - A `StorageListResult` containing the contents of the storage reference.
     func list(maxResults: Int64) async throws -> StorageListResult {
       typealias ListContinuation = CheckedContinuation<StorageListResult, Error>
       return try await withCheckedThrowingContinuation { (continuation: ListContinuation) in
@@ -119,6 +131,9 @@ import Foundation
     ///   - maxResults The maximum number of results to return in a single page. Must be
     ///                greater than 0 and at most 1000.
     ///   - pageToken A page token from a previous call to list.
+    /// - Throws:
+    ///   - An error if the operation failed, for example if Storage was unreachable
+    ///   or the storage reference referenced an invalid path.
     /// - Returns:
     ///   - completion A `Result` enum with either the list or an `Error`.
     func list(maxResults: Int64, pageToken: String) async throws -> StorageListResult {