Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
shilgapira committed Dec 31, 2024
1 parent b3ed686 commit 7dbcfd3
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 2 additions & 0 deletions src/docs/DescopeKit.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ on the [Descope website](https://descope.com).

- ``DescopeFlow``
- ``DescopeFlowState``
- ``DescopeFlowHook``
- ``DescopeFlowView``
- ``DescopeFlowViewDelegate``
- ``DescopeFlowViewController``
Expand All @@ -64,6 +65,7 @@ on the [Descope website](https://descope.com).
- ``UpdateOptions``
- ``DeliveryMethod``
- ``OAuthProvider``
- ``RevokeType``

### Development

Expand Down
6 changes: 3 additions & 3 deletions src/flows/FlowHook.swift
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import WebKit
/// ```
///
/// You can also implement your own hooks by subclassing ``DescopeFlowHook`` and
/// overriding the ``execute(coordinator:)`` method.
/// overriding the ``execute(event:coordinator:)`` method.
@MainActor
open class DescopeFlowHook {

Expand Down Expand Up @@ -222,7 +222,7 @@ extension DescopeFlowHook {
/// }
/// ```
///
/// - Parameter setup: A closure that receives the `UIScrollView` instance as its only parameter.
/// - Parameter closure: A closure that receives the `UIScrollView` instance as its only parameter.
///
/// - Returns: A ``DescopeFlowHook`` object that can be added to the ``DescopeFlow/hooks`` array.
public static func setupScrollView(_ closure: @escaping (UIScrollView) -> Void) -> DescopeFlowHook {
Expand All @@ -233,7 +233,7 @@ extension DescopeFlowHook {
/// Creates a hook that will run the provided closure when the flow is started
/// on the `WKWebView` used to display it.
///
/// - Parameter setup: A closure that receives the `WKWebView` instance as its only parameter.
/// - Parameter closure: A closure that receives the `WKWebView` instance as its only parameter.
///
/// - Returns: A ``DescopeFlowHook`` object that can be added to the ``DescopeFlow/hooks`` array.
public static func setupWebView(_ closure: @escaping (WKWebView) -> Void) -> DescopeFlowHook {
Expand Down
4 changes: 0 additions & 4 deletions src/internal/others/FlowsV0/FlowsV0Runner.swift
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,6 @@ public class DescopeFlowRunner {
/// The host application is expected to intercept this URL via Universal Links and
/// resume the running flow with it.
///
/// You can do this by first getting a reference to the current running flow from
/// the ``DescopeFlow/current`` property and then calling the ``resume(with:)`` method
/// with the URL from the Universal Link.
///
/// @main
/// struct MyApp: App {
/// // ...
Expand Down
1 change: 1 addition & 0 deletions src/sdk/Callbacks.swift
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public extension DescopeAuth {
/// hasn't already been selected.
/// - tenantIds: Provide a non-empty array of tenant IDs and set `dct` to `false`
/// to request a specific list of tenants for the user.
/// - refreshJwt: the `refreshJwt` from an active ``DescopeSession``.
///
/// - Returns: A list of one or more ``DescopeTenant`` values.
func tenants(dct: Bool, tenantIds: [String], refreshJwt: String, completion: @escaping @Sendable (Result<[DescopeTenant], Error>) -> Void) {
Expand Down
1 change: 1 addition & 0 deletions src/sdk/Routes.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public protocol DescopeAuth: Sendable {
/// hasn't already been selected.
/// - tenantIds: Provide a non-empty array of tenant IDs and set `dct` to `false`
/// to request a specific list of tenants for the user.
/// - refreshJwt: the `refreshJwt` from an active ``DescopeSession``.
///
/// - Returns: A list of one or more ``DescopeTenant`` values.
func tenants(dct: Bool, tenantIds: [String], refreshJwt: String) async throws -> [DescopeTenant]
Expand Down

0 comments on commit 7dbcfd3

Please sign in to comment.