Improving API documentation.

Author: Ruben Nine

FilestackSDK/Public/Extensions/Client+ObjC.swift

@@ -30,7 +30,7 @@ extension Client {
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: A `MultipartUpload` object that allows monitoring progress, cancelling the upload request, etc.
+    /// - Returns: An `Uploader` that allows starting, cancelling and monitoring the upload.
     @objc public func uploadURL(using localURL: NSURL,
                                 options: UploadOptions = .defaults,
                                 queue: DispatchQueue = .main,
@@ -62,7 +62,7 @@ extension Client {
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: A `MultifileUpload` object that allows monitoring progress, cancelling the upload request, etc.
+    /// - Returns: An `Uploader` that allows starting, cancelling and monitoring the upload.
     @objc public func uploadMultipleURLs(using localURLs: [NSURL],
                                          options: UploadOptions = .defaults,
                                          queue: DispatchQueue = .main,
@@ -94,7 +94,7 @@ extension Client {
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: An object conforming to `Uploader` that allows starting, cancelling and monitoring the upload.
+    /// - Returns: An `Uploader` that allows starting, cancelling and monitoring the upload.
     @objc public func uploadData(using data: NSData,
                                  options: UploadOptions = .defaults,
                                  queue: DispatchQueue = .main,
@@ -126,7 +126,7 @@ extension Client {
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: An object conforming to `Uploader` that allows starting, cancelling and monitoring the upload.
+    /// - Returns: An `Uploader` that allows starting, cancelling and monitoring the upload.
     @objc public func uploadMultipleData(using multipleData: [NSData],
                                          options: UploadOptions = .defaults,
                                          queue: DispatchQueue = .main,

FilestackSDK/Public/Models/Client.swift

@@ -118,7 +118,7 @@ import Foundation
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: An object conforming to `Uploader` that allows starting, cancelling and monitoring the upload.
+    /// - Returns: An `Uploader` that allows starting, cancelling and monitoring the upload.
     @discardableResult
     public func upload(using uploadable: Uploadable,
                        options: UploadOptions = .defaults,
@@ -154,8 +154,8 @@ import Foundation
     /// of the upload process as data is uploaded to the server. `nil` by default.
     /// - Parameter completionHandler: Adds a handler to be called once the upload has finished.
     ///
-    /// - Returns: An object conforming to `Uploader` and `DeferredAdd` that allows starting, cancelling and monitoring
-    /// the upload, plus adding `Uploadables` at a later time.
+    /// - Returns: An `Uploader & DeferredAdd` that allows starting, cancelling and monitoring the upload, plus adding
+    /// `Uploadables` at a later time.
     @discardableResult
     public func upload(using uploadables: [Uploadable]? = nil,
                        options: UploadOptions = .defaults,