Add code comments

README.md

@@ -30,7 +30,7 @@ Flare is a framework written in Swift that makes it easy for you to work with in
 - [x] Support Subscription Purchase
 - [x] Support Promotional & Introductory Offers
 - [x] iOS, tvOS, watchOS, macOS, and visionOS compatible
-- [x] Complete Unit Test & Integration Coverage
+- [x] Complete Unit & Integration Test Coverage
 
 ## Documentation
 Check out [flare documentation](https://space-code.github.io/flare/documentation/flare/).

Sources/Flare/Classes/DI/FlareDependencies.swift

@@ -7,7 +7,10 @@ import Concurrency
 import Foundation
 import StoreKit
 
+/// The package's dependencies.
 final class FlareDependencies: IFlareDependencies {
+    // MARK: Internal
+
     lazy var iapProvider: IIAPProvider = IAPProvider(
         paymentQueue: SKPaymentQueue.default(),
         productProvider: productProvider,

Sources/Flare/Classes/Foundation/UserDefaults/IUserDefaults.swift

@@ -5,7 +5,20 @@
 
 import Foundation
 
+/// Protocol for managing `UserDefaults` operations.
 protocol IUserDefaults {
+    /// Sets a `Codable` value in `UserDefaults` for a given key.
+    ///
+    /// - Parameters:
+    ///   - key: The key to associate with the Codable value.
+    ///
+    ///   - codable: The Codable value to be stored.
     func set<T: Codable>(key: String, codable: T)
+
+    /// Retrieves a `Codable` value from `UserDefaults` for a given key.
+    ///
+    /// - Parameter key: The key associated with the desired Codable value.
+    ///
+    /// - Returns: The Codable value stored for the given key, or nil if not found.
     func get<T: Codable>(key: String) -> T?
 }

Sources/Flare/Classes/Models/DiscountType.swift

@@ -8,6 +8,7 @@ import StoreKit
 
 // MARK: - DiscountType
 
+/// The type of discount offer.
 public enum DiscountType: Int, Sendable {
     /// Introductory offer
     case introductory = 0

Sources/Flare/Classes/Models/Internal/ProductsRequest.swift

@@ -6,15 +6,21 @@
 import Foundation
 import StoreKit
 
+/// A class that represents a request to the App Store.
 final class ProductsRequest: ISKRequest {
     // MARK: Properties
 
+    /// The request.
     private let request: SKRequest
 
+    /// The request’s identifier.
     var id: String { request.id }
 
     // MARK: Initialization
 
+    /// Creates a `ProductsRequest` instance.
+    ///
+    /// - Parameter request: The request.
     init(_ request: SKRequest) {
         self.request = request
     }

Sources/Flare/Classes/Models/Internal/Protocols/ISKProduct.swift

@@ -34,11 +34,12 @@ protocol ISKProduct {
     /// The subscription period for the product, if applicable.
     var subscriptionPeriod: SubscriptionPeriod? { get }
 
-    /// <#Description#>
+    /// The details of an introductory offer for an auto-renewable subscription.
     var introductoryDiscount: StoreProductDiscount? { get }
 
-    /// <#Description#>
+    /// The details of promotional offers for an auto-renewable subscription.
     var discounts: [StoreProductDiscount] { get }
 
+    /// The subscription group identifier.
     var subscriptionGroupIdentifier: String? { get }
 }

Sources/Flare/Classes/Models/Internal/Protocols/ISKRequest.swift

@@ -5,6 +5,8 @@
 
 import Foundation
 
+/// Type that represents a request to the App Store.
 protocol ISKRequest: Hashable {
+    /// The request’s identifier.
     var id: String { get }
 }

Sources/Flare/Classes/Models/PromotionalOffer.swift

@@ -8,14 +8,22 @@ import StoreKit
 
 // MARK: - PromotionalOffer
 
+/// A class representing a promotional offer.
 public final class PromotionalOffer: NSObject, Sendable {
     // MARK: Properties
 
+    /// The details of an introductory offer or a promotional offer for an auto-renewable subscription.
     public let discount: StoreProductDiscount
+    /// The signed discount applied to a payment.
     public let signedData: SignedData
 
     // MARK: Initialization
 
+    /// Creates a `PromotionalOffer` instance.
+    ///
+    /// - Parameters:
+    ///   - discount: The details of an introductory offer or a promotional offer for an auto-renewable subscription.
+    ///   - signedData: The signed discount applied to a payment.
     public init(discount: StoreProductDiscount, signedData: SignedData) {
         self.discount = discount
         self.signedData = signedData
@@ -25,15 +33,30 @@ public final class PromotionalOffer: NSObject, Sendable {
 // MARK: PromotionalOffer.SignedData
 
 public extension PromotionalOffer {
+    /// The signed discount applied to a payment.
     final class SignedData: NSObject, Sendable {
         // MARK: Properties
 
+        /// The identifier agreed upon with the App Store for a discount of your choosing.
         public let identifier: String
+        /// The identifier of the public/private key pair agreed upon with the App Store when the keys were generated.
         public let keyIdentifier: String
+        /// One-time use random entropy-adding value for security.
         public let nonce: UUID
+        /// The cryptographic signature generated by your private key.
         public let signature: String
+        /// Timestamp of when the signature is created.
         public let timestamp: Int
 
+        /// Creates a `SignedData` instance.
+        ///
+        /// - Parameters:
+        ///   - identifier: The identifier agreed upon with the App Store for a discount of your choosing.
+        ///   - keyIdentifier: The identifier of the public/private key pair agreed upon
+        ///                    with the App Store when the keys were generated.
+        ///   - nonce: One-time use random entropy-adding value for security.
+        ///   - signature: The cryptographic signature generated by your private key.
+        ///   - timestamp: Timestamp of when the signature is created.
         public init(identifier: String, keyIdentifier: String, nonce: UUID, signature: String, timestamp: Int) {
             self.identifier = identifier
             self.keyIdentifier = keyIdentifier
@@ -47,6 +70,9 @@ public extension PromotionalOffer {
 // MARK: - Convenience Initializators
 
 extension PromotionalOffer.SignedData {
+    /// Creates a `SignedData` instance.
+    ///
+    /// - Parameter paymentDiscount: The signed discount applied to a payment.
     convenience init(paymentDiscount: SKPaymentDiscount) {
         self.init(
             identifier: paymentDiscount.identifier,

Sources/Flare/Classes/Providers/CacheProvider/CacheProvider.swift

@@ -7,13 +7,18 @@ import Foundation
 
 // MARK: - CacheProvider
 
+/// A class provides caching functionality.
 final class CacheProvider {
     // MARK: Properties
 
+    /// The user defaults.
     private let userDefaults: IUserDefaults
 
     // MARK: Initialization
 
+    /// Creates a `CacheProvider` instance.
+    ///
+    /// - Parameter userDefaults: The user defaults.
     init(userDefaults: IUserDefaults = UserDefaults.standard) {
         self.userDefaults = userDefaults
     }

Sources/Flare/Classes/Providers/CacheProvider/ICacheProvider.swift

@@ -5,7 +5,7 @@
 
 import Foundation
 
-// Type for a cache provider that supports reading and writing Codable values.
+/// Type for a cache provider that supports reading and writing Codable values.
 protocol ICacheProvider {
     /// Reads a Codable value from the cache using the specified key.
     ///

Sources/Flare/Classes/Providers/ConfigurationProvider/ConfigurationProvider.swift

@@ -7,13 +7,19 @@ import Foundation
 
 // MARK: - ConfigurationProvider
 
+/// A class responsible for providing configuration settings, utilizing a cache provider.
 final class ConfigurationProvider {
     // MARK: Properties
 
+    /// The cache provider used to store and retrieve configuration settings.
     private let cacheProvider: ICacheProvider
 
     // MARK: Initialization
 
+    /// Initializes a ConfigurationProvider with a specified cache provider.
+    ///
+    /// - Parameter cacheProvider: The cache provider to use. Defaults to an instance of
+    ///                            `CacheProvider` with standard UserDefaults.
     init(cacheProvider: ICacheProvider = CacheProvider(userDefaults: UserDefaults.standard)) {
         self.cacheProvider = cacheProvider
     }

Sources/Flare/Classes/Providers/EligibilityProvider/EligibilityProvider.swift

@@ -7,6 +7,7 @@ import Foundation
 
 // MARK: - EligibilityProvider
 
+/// A class that provides eligibility checking functionality.
 final class EligibilityProvider {}
 
 // MARK: IEligibilityProvider

Sources/Flare/Classes/Providers/IAPProvider/IAPProvider.swift

@@ -19,9 +19,9 @@ final class IAPProvider: IIAPProvider {
     private let receiptRefreshProvider: IReceiptRefreshProvider
     /// The provider is responsible for refunding purchases
     private let refundProvider: IRefundProvider
-    ///
+    /// The provider is responsible for eligibility checking.
     private let eligibilityProvider: IEligibilityProvider
-    ///
+    /// The provider is tasked with handling code redemption.
     private let redeemCodeProvider: IRedeemCodeProvider
 
     // MARK: Initialization
@@ -34,6 +34,8 @@ final class IAPProvider: IIAPProvider {
     ///   - purchaseProvider: The provider is respinsible for purchasing StoreKit product.
     ///   - receiptRefreshProvider: The provider is responsible for refreshing receipts.
     ///   - refundProvider: The provider is responsible for refunding purchases.
+    ///   - eligibilityProvider: The provider is responsible for eligibility checking.
+    ///   - redeemCodeProvider: The provider is tasked with handling code redemption.
     init(
         paymentQueue: PaymentQueue,
         productProvider: IProductProvider,