From 1f3c60e445d6325f5c6979821b29fe2909b8f713 Mon Sep 17 00:00:00 2001
From: AJ Lauer Barinov <abarinov@mux.com>
Date: Tue, 4 Jun 2024 18:42:26 -0700
Subject: [PATCH] fixup API docs

use consistent formatting
---
 .../MuxUploadSDK/PublicAPI/DirectUpload.swift | 43 +++++++------------
 .../PublicAPI/DirectUploadManager.swift       |  2 +-
 2 files changed, 16 insertions(+), 29 deletions(-)

diff --git a/Sources/MuxUploadSDK/PublicAPI/DirectUpload.swift b/Sources/MuxUploadSDK/PublicAPI/DirectUpload.swift
index ce4eb38a..61e007ea 100644
--- a/Sources/MuxUploadSDK/PublicAPI/DirectUpload.swift
+++ b/Sources/MuxUploadSDK/PublicAPI/DirectUpload.swift
@@ -24,32 +24,28 @@ public typealias DirectUploadResult = Result<DirectUpload.SuccessDetails, Direct
 /// ```swift
 /// let upload = DirectUpload(
 ///   uploadURL: myDirectUploadURL,
-///   videoFileURL: myVideoFileURL,
+///   inputFileURL: myInputFileURL,
 /// )
 ///
 /// upload.progressHandler = { state in
-///   self.uploadScreenState = .uploading(state)
+///   print("Upload Progress: \(state.progress.fractionCompleted ?? 0)")
 /// }
 ///
 /// upload.resultHandler = { result in
 ///   switch result {
 ///     case .success(let success):
-///     self.uploadScreenState = .done(success)
-///     self.upload = nil
-///     NSLog("Upload Success!")
+///       print("Upload Success!")
 ///     case .failure(let error):
-///     self.uploadScreenState = .failure(error)
-///     NSLog("!! Upload error: \(error.localizedDescription)")
+///       print("Upload Error: \(error.localizedDescription)")
 ///   }
 /// }
 ///
-/// self.upload = upload
 /// upload.start()
 /// ```
 ///
-/// Uploads created by this SDK are globally managed by default, and can be resumed after failures or even after process death. For more information on
-/// this topic, see ``UploadManager``
-///
+/// Uploads created by this SDK are globally managed by default, 
+/// and can be resumed after failures or after an application
+/// restart or termination. For more see ``UploadManager``.
 public final class DirectUpload {
 
     var input: UploadInput {
@@ -170,27 +166,18 @@ public final class DirectUpload {
     
     internal var fileWorker: ChunkedFileUploader?
 
-    /**
-     Represents the state of an upload in progress.
-     */
+    /// Represents the state of an upload when it is being 
+    /// sent to Mux over the network
     public struct TransportStatus : Sendable, Hashable {
-        /**
-         The percentage of file bytes received by the server
-         accepting the upload
-         */
+        /// The percentage of file bytes received at the 
+        /// upload destination
         public let progress: Progress?
-        /**
-         A timestamp indicating when this status was generated
-         */
+        /// Timestamp from when this update was generated
         public let updatedTime: TimeInterval
-        /**
-         The start time of the upload, nil if the upload
-         has never been started
-         */
+        /// The start time of the upload, nil if the upload
+        /// has never been started
         public let startTime: TimeInterval?
-        /**
-         Indicates if the upload has been paused
-         */
+        /// Indicates if the upload has been paused
         public let isPaused: Bool
     }
 
diff --git a/Sources/MuxUploadSDK/PublicAPI/DirectUploadManager.swift b/Sources/MuxUploadSDK/PublicAPI/DirectUploadManager.swift
index 76edfaa5..55fc8c45 100644
--- a/Sources/MuxUploadSDK/PublicAPI/DirectUploadManager.swift
+++ b/Sources/MuxUploadSDK/PublicAPI/DirectUploadManager.swift
@@ -63,7 +63,7 @@ public final class DirectUploadManager {
     }
     
     /// Returns all uploads currently-managed uploads.
-    /// Uploads are managed while in-progress or compelted.
+    /// Uploads are managed while in-progress or completed.
     ///  Uploads become un-managed when canceled, or if the process dies after they complete
     public func allManagedDirectUploads() -> [DirectUpload] {
         // Sort upload list for consistent ordering