Skip to content

Commit

Permalink
docs: add See Also annotation
Browse files Browse the repository at this point in the history
will automatically populate links to related APIs in the generated
API docs
  • Loading branch information
andrewjl-mux committed Jun 6, 2024
1 parent dd66266 commit 214aacf
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Sources/MuxUploadSDK/PublicAPI/DirectUpload.swift
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,7 @@ public final class DirectUpload {
}

/// Handles completion of the uploads execution
/// - SeeAlso: resultHandler
public typealias ResultHandler = (DirectUploadResult) -> Void

/// Sets handler that is notified when the upload completes
Expand Down Expand Up @@ -701,6 +702,7 @@ public final class DirectUpload {
/// to resume the upload from where it left off.
///
/// Call ``cancel()`` to permanently halt the upload.
/// - SeeAlso cancel()
public func pause() {
fileWorker?.pause()
}
Expand Down

0 comments on commit 214aacf

Please sign in to comment.