Add @_documentation(visibility: public)

stripe · Dec 20, 2024 · 3300603 · 3300603
1 parent 4b725fc
commit 3300603
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 6 deletions.
diff --git a/StripeConnect/StripeConnect/Source/Components/AccountOnboardingViewController.swift b/StripeConnect/StripeConnect/Source/Components/AccountOnboardingViewController.swift
@@ -8,8 +8,10 @@
 import UIKit
 
 /// A view controller representing an account-onboarding component
+/// - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
 /// - Seealso: https://docs.stripe.com/connect/supported-embedded-components/account-onboarding
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 public class AccountOnboardingViewController: UIViewController {
 
@@ -68,7 +70,9 @@ public class AccountOnboardingViewController: UIViewController {
 }
 
 /// Delegate of an `AccountOnboardingViewController`
+/// - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 public protocol AccountOnboardingViewControllerDelegate: AnyObject {
     /**

diff --git a/StripeConnect/StripeConnect/Source/Components/PayoutsViewController.swift b/StripeConnect/StripeConnect/Source/Components/PayoutsViewController.swift
@@ -9,8 +9,10 @@ import UIKit
 
 /**
  The balance summary, the payout schedule, and a list of payouts for the connected account. It can also allow the user to perform instant or manual payouts.
+ - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
  */
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 public class PayoutsViewController: UIViewController {
     private(set) var webVC: ConnectComponentWebViewController!
@@ -40,7 +42,9 @@ public class PayoutsViewController: UIViewController {
 }
 
 /// Delegate of an `PayoutsViewController`
+///  - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 public protocol PayoutsViewControllerDelegate: AnyObject {
 

diff --git a/StripeConnect/StripeConnect/Source/CustomFontSource.swift b/StripeConnect/StripeConnect/Source/CustomFontSource.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 extension EmbeddedComponentManager {
 

diff --git a/StripeConnect/StripeConnect/Source/EmbeddedComponentManager+Appearance.swift b/StripeConnect/StripeConnect/Source/EmbeddedComponentManager+Appearance.swift
@@ -10,6 +10,7 @@
 import UIKit
 
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 extension EmbeddedComponentManager {
     /// Describes the appearance of embedded components.

diff --git a/StripeConnect/StripeConnect/Source/EmbeddedComponentManager.swift b/StripeConnect/StripeConnect/Source/EmbeddedComponentManager.swift
@@ -12,7 +12,9 @@ import UIKit
 /// Manages Connect embedded components
 /// - Seealso: https://docs.stripe.com/connect/get-started-connect-embedded-components
 /// - Note: Connect embedded components are only available in private beta.
+/// - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 @available(iOS 15, *)
 public class EmbeddedComponentManager {
     let apiClient: STPAPIClient
@@ -33,11 +35,11 @@ public class EmbeddedComponentManager {
         ComponentAnalyticsClient(client: AnalyticsClientV2.sharedConnect,
                                  commonFields: $0)
     }
-    
+
     var baseURL: URL = StripeConnectConstants.connectJSBaseURL
 
-    var publicKeyOverride: String? = nil
-    
+    var publicKeyOverride: String?
+
     @_spi(DashboardOnly)
     public convenience init(apiClient: STPAPIClient = STPAPIClient.shared,
                             appearance: EmbeddedComponentManager.Appearance = .default,
@@ -56,8 +58,7 @@ public class EmbeddedComponentManager {
             baseURL = baseURLOverride
         }
     }
-
-
+
     /**
      Initializes an EmbeddedComponentManager instance.
 

diff --git a/StripeConnect/StripeConnect/Source/Helpers/EmbeddedComponentError.swift b/StripeConnect/StripeConnect/Source/Helpers/EmbeddedComponentError.swift
@@ -8,7 +8,9 @@
 import Foundation
 
 /// An error that can occur loading a Connect embedded component
+/// - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
 @_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 public struct EmbeddedComponentError: Error, CustomDebugStringConvertible {
     public enum ErrorType: String {
         /// Failure to connect to Stripe's API

diff --git a/StripeConnect/StripeConnect/Source/Models/AccountCollectionOptions.swift b/StripeConnect/StripeConnect/Source/Models/AccountCollectionOptions.swift
@@ -7,8 +7,10 @@
 
 import Foundation
 
-@_spi(PrivateBetaConnect)
 /// Collection options for account onboarding
+/// - Important: Include  `@_spi(PrivateBetaConnect)` on import to gain access to this API.
+@_spi(PrivateBetaConnect)
+@_documentation(visibility: public)
 public struct AccountCollectionOptions: Equatable, Codable {
 
     public enum FieldOption: String, Codable {