Code-level documentation updates

SwiftyStoreKit/PaymentQueueController.swift

@@ -28,9 +28,9 @@ import StoreKit
 protocol TransactionController {
 
     /**
-     * - param transactions: transactions to process
-     * - param paymentQueue: payment queue for finishing transactions
-     * - return: array of unhandled transactions
+     * - parameter transactions: transactions to process
+     * - parameter paymentQueue: payment queue for finishing transactions
+     * - returns: array of unhandled transactions
      */
     func processTransactions(_ transactions: [SKPaymentTransaction], on paymentQueue: PaymentQueue) -> [SKPaymentTransaction]
 }

SwiftyStoreKit/SKProduct+LocalizedPrice.swift

@@ -37,4 +37,5 @@ public extension SKProduct {
         formatter.numberStyle = .currency
         return formatter
     }
+    
 }

SwiftyStoreKit/SwiftyStoreKit+Types.swift

@@ -26,20 +26,20 @@ import StoreKit
 
 // MARK: Purchases
 
-// Restored product
-// The Purchased protocol allows different purchase flows to be handled by common code in simple cases
-// For example you could route through to
-//
-// func didPurchase<P:Purchased>(item:P) { ... }
-//
-// for example
-// SwiftyStoreKit.completeTransactions (in .purchased and .restored cases)
-// SwiftyStoreKit.restorePurchases (for results.restoredPurchases)
-// SwiftyStoreKit.purchaseProducd (in .success case)
+/// The Purchased protocol allows different purchase flows to be handled by common code in simple cases
+/// 
+/// For example you could route through to
+///
+///     func didPurchase<P:Purchased>(item:P) { ... }
+///
+/// for example
+///  - SwiftyStoreKit.completeTransactions (in .purchased and .restored cases)
+///  - SwiftyStoreKit.restorePurchases (for results.restoredPurchases)
+///  - SwiftyStoreKit.purchaseProducd (in .success case)
 public protocol Purchased {
-    var productId: String {get}
-    var quantity: Int {get}
-    var originalPurchaseDate: Date {get}
+    var productId: String { get }
+    var quantity: Int { get }
+    var originalPurchaseDate: Date { get }
 }
 
 extension Purchase: Purchased {
@@ -60,7 +60,6 @@ extension PurchaseDetails: Purchased {
     }
 }
 
-
 // Restored product
 public struct Purchase {
     public let productId: String
@@ -78,7 +77,7 @@ public struct Purchase {
     }
 }
 
-// Purchased product
+/// Purchased product
 public struct PurchaseDetails {
     public let productId: String
     public let quantity: Int
@@ -97,12 +96,12 @@ public struct PurchaseDetails {
     }
 }
 
-//Conform to this protocol to provide custom receipt validator
+/// Conform to this protocol to provide custom receipt validator
 public protocol ReceiptValidator {
 	func validate(receiptData: Data, completion: @escaping (VerifyReceiptResult) -> Void)
 }
 
-// Payment transaction
+/// Payment transaction
 public protocol PaymentTransaction {
     var transactionDate: Date? { get }
     var transactionState: SKPaymentTransactionState { get }
@@ -110,10 +109,10 @@ public protocol PaymentTransaction {
     var downloads: [SKDownload] { get }
 }
 
-// Add PaymentTransaction conformance to SKPaymentTransaction
+/// Add PaymentTransaction conformance to SKPaymentTransaction
 extension SKPaymentTransaction: PaymentTransaction { }
 
-// Products information
+/// Products information
 public struct RetrieveResults {
     public let retrievedProducts: Set<SKProduct>
     public let invalidProductIDs: Set<String>
@@ -126,13 +125,13 @@ public struct RetrieveResults {
     }
 }
 
-// Purchase result
+/// Purchase result
 public enum PurchaseResult {
     case success(purchase: PurchaseDetails)
     case error(error: SKError)
 }
 
-// Restore purchase results
+/// Restore purchase results
 public struct RestoreResults {
     public let restoredPurchases: [Purchase]
     public let restoreFailedPurchases: [(SKError, String?)]
@@ -148,28 +147,28 @@ public typealias UpdatedDownloadsHandler = (_ downloads: [SKDownload]) -> Void
 
 // MARK: Receipt verification
 
-// Info for receipt returned by server
+/// Info for receipt returned by server
 public typealias ReceiptInfo = [String: AnyObject]
 
-// Fetch receipt result
+/// Fetch receipt result
 public enum FetchReceiptResult {
     case success(receiptData: Data)
     case error(error: ReceiptError)
 }
 
-// Verify receipt result
+/// Verify receipt result
 public enum VerifyReceiptResult {
     case success(receipt: ReceiptInfo)
     case error(error: ReceiptError)
 }
 
-// Result for Consumable and NonConsumable
+/// Result for Consumable and NonConsumable
 public enum VerifyPurchaseResult {
     case purchased(item: ReceiptItem)
     case notPurchased
 }
 
-// Verify subscription result
+/// Verify subscription result
 public enum VerifySubscriptionResult {
     case purchased(expiryDate: Date, items: [ReceiptItem])
     case expired(expiryDate: Date, items: [ReceiptItem])
@@ -236,30 +235,31 @@ public enum ReceiptError: Swift.Error {
     case receiptInvalid(receipt: ReceiptInfo, status: ReceiptStatus)
 }
 
-// Status code returned by remote server
-// see Table 2-1  Status codes
+/// Status code returned by remote server
+/// 
+/// See Table 2-1  Status codes
 public enum ReceiptStatus: Int {
-    // Not decodable status
+    /// Not decodable status
     case unknown = -2
-    // No status returned
+    /// No status returned
     case none = -1
-    // valid statu
+    /// valid statua
     case valid = 0
-    // The App Store could not read the JSON object you provided.
+    /// The App Store could not read the JSON object you provided.
     case jsonNotReadable = 21000
-    // The data in the receipt-data property was malformed or missing.
+    /// The data in the receipt-data property was malformed or missing.
     case malformedOrMissingData = 21002
-    // The receipt could not be authenticated.
+    /// The receipt could not be authenticated.
     case receiptCouldNotBeAuthenticated = 21003
-    // The shared secret you provided does not match the shared secret on file for your account.
+    /// The shared secret you provided does not match the shared secret on file for your account.
     case secretNotMatching = 21004
-    // The receipt server is not currently available.
+    /// The receipt server is not currently available.
     case receiptServerUnavailable = 21005
-    // This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response.
+    /// This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response.
     case subscriptionExpired = 21006
-    //  This receipt is from the test environment, but it was sent to the production environment for verification. Send it to the test environment instead.
+    ///  This receipt is from the test environment, but it was sent to the production environment for verification. Send it to the test environment instead.
     case testReceipt = 21007
-    // This receipt is from the production environment, but it was sent to the test environment for verification. Send it to the production environment instead.
+    /// This receipt is from the production environment, but it was sent to the test environment for verification. Send it to the production environment instead.
     case productionEnvironment = 21008
 
     var isValid: Bool { return self == .valid}
@@ -267,51 +267,51 @@ public enum ReceiptStatus: Int {
 
 // Receipt field as defined in : https://developer.apple.com/library/ios/releasenotes/General/ValidateAppStoreReceipt/Chapters/ReceiptFields.html#//apple_ref/doc/uid/TP40010573-CH106-SW1
 public enum ReceiptInfoField: String {
-    // Bundle Identifier. This corresponds to the value of CFBundleIdentifier in the Info.plist file.
+    /// Bundle Identifier. This corresponds to the value of CFBundleIdentifier in the Info.plist file.
     case bundle_id
-    // The app’s version number.This corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in OS X) in the Info.plist.
+    /// The app’s version number.This corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in OS X) in the Info.plist.
     case application_version
-    // The version of the app that was originally purchased. This corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in OS X) in the Info.plist file when the purchase was originally made.
+    /// The version of the app that was originally purchased. This corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in OS X) in the Info.plist file when the purchase was originally made.
     case original_application_version
-    // The date when the app receipt was created.
+    /// The date when the app receipt was created.
     case creation_date
-    // The date that the app receipt expires. This key is present only for apps purchased through the Volume Purchase Program.
+    /// The date that the app receipt expires. This key is present only for apps purchased through the Volume Purchase Program.
     case expiration_date
 
-    // The receipt for an in-app purchase.
+    /// The receipt for an in-app purchase.
     case in_app
 
     public enum InApp: String {
-        // The number of items purchased. This value corresponds to the quantity property of the SKPayment object stored in the transaction’s payment property.
+        /// The number of items purchased. This value corresponds to the quantity property of the SKPayment object stored in the transaction’s payment property.
         case quantity
-        // The product identifier of the item that was purchased. This value corresponds to the productIdentifier property of the SKPayment object stored in the transaction’s payment property.
+        /// The product identifier of the item that was purchased. This value corresponds to the productIdentifier property of the SKPayment object stored in the transaction’s payment property.
         case product_id
-        // The transaction identifier of the item that was purchased. This value corresponds to the transaction’s transactionIdentifier property.
+        /// The transaction identifier of the item that was purchased. This value corresponds to the transaction’s transactionIdentifier property.
         case transaction_id
-        // For a transaction that restores a previous transaction, the transaction identifier of the original transaction. Otherwise, identical to the transaction identifier. This value corresponds to the original transaction’s transactionIdentifier property. All receipts in a chain of renewals for an auto-renewable subscription have the same value for this field.
+        /// For a transaction that restores a previous transaction, the transaction identifier of the original transaction. Otherwise, identical to the transaction identifier. This value corresponds to the original transaction’s transactionIdentifier property. All receipts in a chain of renewals for an auto-renewable subscription have the same value for this field.
         case original_transaction_id
-        // The date and time that the item was purchased. This value corresponds to the transaction’s transactionDate property.
+        /// The date and time that the item was purchased. This value corresponds to the transaction’s transactionDate property.
         case purchase_date
-        // For a transaction that restores a previous transaction, the date of the original transaction. This value corresponds to the original transaction’s transactionDate property. In an auto-renewable subscription receipt, this indicates the beginning of the subscription period, even if the subscription has been renewed.
+        /// For a transaction that restores a previous transaction, the date of the original transaction. This value corresponds to the original transaction’s transactionDate property. In an auto-renewable subscription receipt, this indicates the beginning of the subscription period, even if the subscription has been renewed.
         case original_purchase_date
-        // The expiration date for the subscription, expressed as the number of milliseconds since January 1, 1970, 00:00:00 GMT. This key is only present for auto-renewable subscription receipts.
+        /// The expiration date for the subscription, expressed as the number of milliseconds since January 1, 1970, 00:00:00 GMT. This key is only present for auto-renewable subscription receipts.
         case expires_date
-        // For a transaction that was canceled by Apple customer support, the time and date of the cancellation. Treat a canceled receipt the same as if no purchase had ever been made.
+        /// For a transaction that was canceled by Apple customer support, the time and date of the cancellation. Treat a canceled receipt the same as if no purchase had ever been made.
         case cancellation_date
         #if os(iOS) || os(tvOS)
-        // A string that the App Store uses to uniquely identify the application that created the transaction. If your server supports multiple applications, you can use this value to differentiate between them. Apps are assigned an identifier only in the production environment, so this key is not present for receipts created in the test environment. This field is not present for Mac apps. See also Bundle Identifier.
+        /// A string that the App Store uses to uniquely identify the application that created the transaction. If your server supports multiple applications, you can use this value to differentiate between them. Apps are assigned an identifier only in the production environment, so this key is not present for receipts created in the test environment. This field is not present for Mac apps. See also Bundle Identifier.
         case app_item_id
         #endif
-        // An arbitrary number that uniquely identifies a revision of your application. This key is not present for receipts created in the test environment.
+        /// An arbitrary number that uniquely identifies a revision of your application. This key is not present for receipts created in the test environment.
         case version_external_identifier
-        // The primary key for identifying subscription purchases.
+        /// The primary key for identifying subscription purchases.
         case web_order_line_item_id
     }
 }
 
 #if os(OSX)
     public enum ReceiptExitCode: Int32 {
-        // If validation fails in OS X, call exit with a status of 173. This exit status notifies the system that your application has determined that its receipt is invalid. At this point, the system attempts to obtain a valid receipt and may prompt for the user’s iTunes credentials
+        /// If validation fails in OS X, call exit with a status of 173. This exit status notifies the system that your application has determined that its receipt is invalid. At this point, the system attempts to obtain a valid receipt and may prompt for the user’s iTunes credentials
         case notValid = 173
     }
 #endif