Improve description comments with gpt4

Author: eonist

README.md

@@ -96,6 +96,7 @@ UpgradeAlert.showAlert(appInfo: .init(version: "1.0.1", trackViewUrl: "https://a
 - Maybe add 1 day delay to showing update alert: to avoid an issue where Apple updates the JSON faster than the app binary propogates to the App Store. https://github.com/amebalabs/AppVersion/blob/master/AppVersion/Source/%20Extensions/Date%2BAppVersion.swift
 - Doc params
 - Clean up comments
+- Add support for swiftui
 
 ## License
 This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.

Sources/UpgradeAlert/UpgradeAlert+Variables.swift

@@ -6,6 +6,7 @@ extension UpgradeAlert {
    /**
     * Computed property to generate the request URL for app information.
     * It uses the bundle identifier of the current app to create the URL.
+    * - Description: This property constructs a URL used to fetch information about the application from the iTunes API based on the application's bundle identifier.
     * - Returns: A URL pointing to the app's information on iTunes.
     * - Note: This URL might need a country code for region-specific apps.
     * - Fixme: ⚠️️ Consider renaming this to appInfoRequestURL for clarity.
@@ -23,6 +24,7 @@ extension UpgradeAlert {
 extension UpgradeAlert {
    /**
     * Typealias for a function that generates an alert message.
+    * - Description: Defines a function type used to generate a custom alert message based on the app's name and version.
     * - Parameters:
     *   - appName: The name of the app. This can be nil.
     *   - version: The version of the app.
@@ -32,6 +34,7 @@ extension UpgradeAlert {
    public typealias AlertMessage = (_ appName: String?, _ version: String) -> String
    /**
     * Typealias for a completion handler function.
+    * - Description: Defines a closure used as a completion handler to process the outcome of an update check or alert interaction.
     * - Parameters:
     *   - outcome: The outcome of the operation, encapsulated in a UAOutcome object.
     * - Note: This function does not return a value.
@@ -40,6 +43,7 @@ extension UpgradeAlert {
    /**
     * Default completion handler function.
     * This function simply prints the outcome of the operation.
+    * - Description: This default completion handler logs the outcome of the operation to the console, providing a simple way to observe the results of the update check or alert interaction.
     */
    public static let defaultComplete: Complete = { (outcome: UAOutcome) in
       Swift.print("default complete - outcome: \(String(describing: outcome))")
@@ -51,6 +55,7 @@ extension UpgradeAlert {
 extension UpgradeAlert {
    /**
     * Static property to hold the configuration for UpgradeAlert.
+    * - Description: Holds the configuration settings for the UpgradeAlert system, which can be customized as needed.
     * - Note: By default, it uses the default configuration defined in UAConfig.
     */
    public static var config: UAConfig = .defaultConfig

Sources/UpgradeAlert/UpgradeAlert.swift

@@ -5,6 +5,7 @@ import UIKit
 import Cocoa
 #endif
 /**
+ * - Description: The `UpgradeAlert` class is responsible for managing the update notification process within an application. It checks for new versions of the app on the App Store, compares it with the current version, and alerts the user if an update is necessary.
  * - Remark: What if a user doesn't want to update and there is no other option than to update?
  * - Remark: If the app always show popup when getting focus. Then activate flight-mode. Launch the app again.
  * - Remark: Title and message are optional, default values are used if nil etc
@@ -17,6 +18,7 @@ public final class UpgradeAlert {}
 extension UpgradeAlert {
    /**
     * Check for updates
+    * - Description: Initiates a check for new versions of the app available on the App Store. If a newer version is found, it prompts the user with an update alert.
     * - Remark: shows alert with one or two btns
     * - Parameter: withConfirmation You can force the update by calling, Or the user can choose if they want to update now or later by calling
     * - Remark: Version of the app you want to mark for the update. For example, 1.0.0 // This is the version you want the user to force upgrade to a newer version.
@@ -61,6 +63,7 @@ extension UpgradeAlert {
  */
 extension UpgradeAlert {
    /**
+    * - Description: Retrieves the app information from the App Store using a network request. This function fetches the JSON data from the App Store API and decodes it to `AppInfo` format, handling errors appropriately.
     * let url = URL(string: "http://www.")
     * - Remark: The url will work if the app is available for all markets. but if the app is removed from some countries. the url wont work. language code must be added etc: see: https://medium.com/usemobile/get-app-version-from-app-store-and-more-e43c5055156a
     * - Note: More url and json parsing here: https://github.com/appupgrade-dev/app-upgrade-ios-sdk/blob/main/Sources/AppUpgrade/AppUpgradeApi.swift
@@ -95,13 +98,13 @@ extension UpgradeAlert {
       task.resume()
    }
 }
-
 /**
  * Alert
  */
 extension UpgradeAlert {
    /**
     * Example code for iOS: mark with os fence
+    * - Description: Presents an alert to the user with options based on the app's update requirements. The alert informs the user about the availability of a new version and provides options to update immediately or defer the update.
     * - Remark: For macOS it coud be wise to add some comment regarding setting system-wide autoupdate to avoid future alert popups etc
     * - Remark: Can be used: "itms-apps://itunes.apple.com/app/\(appId)")
     * - Remark: "itms-apps://itunes.apple.com/app/apple-store/id375380948?mt=8"

Sources/UpgradeAlert/ext/Bundle+Ext.swift

@@ -5,23 +5,32 @@ import Foundation
 extension Bundle {
    /**
     * The name of the main bundle.
+    * - Description: Retrieves the name of the main bundle of the application.
+    * Example: `let appName = Bundle.name`
     */
    internal static let name: String? = Bundle.main.object(forInfoDictionaryKey: kCFBundleNameKey as String) as? String
    /**
     * The version of the main bundle.
+    * - Description: Retrieves the version number of the main bundle of the application.
+    * Example: `let appVersion = Bundle.version`
     */
    internal static let version: String? = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String
    /**
     * The build number of the main bundle.
+    * - Description: Retrieves the build number of the main bundle of the application.
+    * Example: `let buildNumber = Bundle.build`
     */
    internal static let build: String? = Bundle.main.object(forInfoDictionaryKey: kCFBundleVersionKey as String) as? String
    /**
     * The identifier of the main bundle.
+    * - Description: Retrieves the unique identifier of the main bundle of the application.
+    * Example: `let bundleIdentifier = Bundle.identifier`
     */
    internal static let identifier: String? = Bundle.main.object(forInfoDictionaryKey: kCFBundleIdentifierKey as String) as? String
    /**
     * Tests if an app is in beta
-    * Description: determines if beta from receipt
+    * - Abstract: determines if beta from receipt
+    * - Description: Determines if the application is a beta version by checking the app store receipt URL for specific substrings that identify simulator or TestFlight environments.
     * - Note: From here: https://stackoverflow.com/a/38984554/5389500
     * - Note: More complex example: https://stackoverflow.com/a/33830605/5389500
     * - Note: Another example: https://stackoverflow.com/a/59047187/5389500
@@ -30,13 +39,17 @@ extension Bundle {
     * - Note: Seems like this can determine if an app is beta: https://developer.apple.com/documentation/appstoreconnectapi/list_all_builds_of_an_app
     * - Fixme: ⚠️️  Here is code that checks if something is testflight: https://gist.github.com/lukaskubanek/cbfcab29c0c93e0e9e0a16ab09586996
     * fix. we could make BundleError enum BundleError: Error { case appStoreReceiptURLNotFound }
+    * Example: `let isBeta = Bundle.isBeta`
     */
    public static var isBeta: Bool { // was named: isSimulatorOrTestFlight
+      // Retrieves the path of the app store receipt URL, if it exists.
       guard let path: String = Bundle.main.appStoreReceiptURL?.path else {
          Swift.print("isBeta - appStoreReceiptURL not found")
          return false
       }
+      // Determines if the application is running in a simulator environment by checking for "CoreSimulator" in the app store receipt URL path.
       let isSimulator: Bool = path.contains("CoreSimulator") // Can also use #if !targetEnvironment(simulator)  #else #endif here
+      // Determines if the app is distributed via TestFlight by checking for "sandboxReceipt" in the app store receipt URL path.
       let isTestFlight: Bool = path.contains("sandboxReceipt")
       return isSimulator || isTestFlight
    }

Sources/UpgradeAlert/ext/NSAlert+Ext.swift

@@ -4,7 +4,7 @@ import Cocoa
 extension NSAlert {
    /**
     * Presents a warning alert to the user with customizable text, buttons, and completion handler.
-    * 
+    * - Description: Displays a modal alert dialog on macOS with customizable titles for the buttons and a completion handler to capture the user's response.
     * ## Examples:
     * NSAlert.present(question: "Ok?", text: "Choose your answer.") { answer in
     *   print(answer)
@@ -19,10 +19,10 @@ extension NSAlert {
     *   - complete: A closure that is called when the user dismisses the alert. The closure takes a single Boolean parameter that is true if the user clicked the OK button and false otherwise.
     */
    internal static func present(question: String, text: String, okTitle: String? = "OK", cancelTitle: String? = "Cancel", view: NSView? = nil, complete: ((_ answer: Bool) -> Void)?) {
-      let alert: NSAlert = .init()
-      alert.messageText = question
-      alert.informativeText = text
-      alert.alertStyle = .warning
+      let alert: NSAlert = .init() // Initializes a new NSAlert object.
+      alert.messageText = question // Sets the primary message text of the alert.
+      alert.informativeText = text // Sets the secondary, informative text of the alert.
+      alert.alertStyle = .warning // Sets the alert style to warning, indicating the nature of the alert.
       // Add OK button to the alert
       if let okTitle: String = okTitle { alert.addButton(withTitle: okTitle) }
       // Add Cancel button to the alert
@@ -43,7 +43,3 @@ extension NSAlert {
    }
 }
 #endif
-//if anAlert.runModal() == .alertFirstButtonReturn {
-//   return .terminateNow
-//}
-//return .terminateLater

Sources/UpgradeAlert/ext/UIAlertController+Ext.swift

@@ -4,6 +4,7 @@ import UIKit
 extension UIAlertController {
    /**
     * Present alert
+    * - Description: Presents the alert controller modally on the currently active view controller or the root view controller if no other controllers are presented.
     * Fix: throw error if vc is not available?
     */
    internal func present() {
@@ -16,6 +17,7 @@ extension UIAlertController {
 extension UIAlertController {
    /**
     * Presented or root view-controller
+    * - Description: Retrieves the currently presented view controller or the root view controller if no other view controller is presented.
     * - Note: Sometimes there is no vc: https://stackoverflow.com/a/30509569/5389500
     */
    fileprivate static var presentedOrRootVC: UIViewController? {

Sources/UpgradeAlert/ext/UIApplication+Ext.swift

@@ -6,11 +6,13 @@ import UIKit
 extension UIApplication {
    /**
     * Key window property.
+    * - Description: Retrieves the primary window of the application that is currently receiving user events.
     * - Remark: The key scene can be found by accessing `keyWin.windowScene`.
     * - Returns: The key window if it exists, otherwise nil.
     */
    internal var keyWin: UIWindow? {
       self
+         // Retrieves all connected scenes of the application.
          .connectedScenes
          // Flatten the array of windows from each UIWindowScene
          .flatMap { ($0 as? UIWindowScene)?.windows ?? [] }

Sources/UpgradeAlert/helper/AppInfo.swift

@@ -3,23 +3,26 @@ import Foundation
 /**
  * This struct represents the basic information about an application.
  * It includes the current version of the application and the URL to the application's page on the App Store.
- * 
+ * - Description: This struct encapsulates essential details about the application, such as its current version and the URL to its App Store page, facilitating easy access to its public listing for update and review purposes.
  * - Remark: More information such as rating, release date, release notes etc. can be fetched. For more details, see: https://github.com/amebalabs/AppVersion/blob/master/AppVersion/Source/AppStoreVersion.swift
  * - Fixme: ⚠️️  Consider renaming this struct to UAAppInfo for better clarity.
  * - Fixme: ⚠️️ Add more detailed documentation for this struct and its properties.
  */
 public struct AppInfo: Decodable {
    /**
     * The current version of the application.
+    * - Description: Specifies the version of the application as a string, which is used to determine if an update is needed.
     */
    public let version: String
    /**
     * The URL to the application's page on the App Store.
     * This might be optional for macOS applications as they might not have an App Store page.
+    * - Description: Specifies the URL to the application's page on the App Store, which can be used to direct users to update or review the app.
     */
    public let trackViewUrl: String
    /**
     * Initializes a new instance of `AppInfo`.
+    * - Description: Initializes a new instance of `AppInfo` with the specified version and App Store URL.
     * - Parameters:
     *   - version: The current version of the application.
     *   - trackViewUrl: The URL to the application's page on the App Store.

Sources/UpgradeAlert/helper/LookupResult.swift

@@ -1,13 +1,14 @@
 import Foundation
 /**
  * `LookupResult` is a struct that conforms to the `Decodable` protocol.
+ * - Description: Represents the result of a lookup operation in the Apple App Store API, encapsulating the relevant app information fetched.
  * It is used to parse the JSON response from the Apple App Store API.
  * The parsed data is stored in the `results` array, which contains instances of `AppInfo`.
- *
  * - Note: This struct is part of the `UpgradeAlert` module, specifically under the `helper` directory.
  */
 struct LookupResult: Decodable {
    // `results` is an array of `AppInfo` instances.
    // Each `AppInfo` instance represents the information of an app retrieved from the Apple App Store API.
+   // Description: An array holding the app information fetched from the Apple App Store API.
    let results: [AppInfo]
 }

Sources/UpgradeAlert/helper/UAConfig.swift

@@ -2,31 +2,37 @@ import Foundation
 /**
  * This struct is used to configure the Upgrade Alert (UA).
  * It contains all the necessary parameters to customize the alert message.
+ * - Description: This struct configures the behavior and presentation of upgrade alerts within the application, allowing customization of alert titles, messages, and button labels based on the upgrade requirements.
  */
 public struct UAConfig {
    /**
     * Determines whether the upgrade is mandatory or optional.
+    * - Description: Indicates if the update is compulsory, requiring immediate action, or if it can be deferred.
     */
    let isRequired: Bool
    /**
     * The title of the alert.
+    * - Description: The title displayed on the upgrade alert, informing the user of the nature of the alert.
     */
    let alertTitle: String
    /**
     * The message of the alert. It's a function that takes the app name and version as parameters.
+    * - Description: Specifies the content of the alert message, dynamically generated based on the application's name and the new version available.
     */
    let alertMessage: UpgradeAlert.AlertMessage
    /**
     * The title of the button that allows the user to postpone the upgrade.
+    * - Description: The title of the button that allows the user to defer the upgrade process, providing an option to initiate it at a later time.
     */
    let laterButtonTitle: String
    /**
     * The title of the button that initiates the upgrade.
+    * - Description: The title of the button that initiates the upgrade process, prompting the user to immediately download and install the latest version of the application.
     */
    let updateButtonTitle: String
    /**
     * Initializes a new UAConfig with the given parameters.
-    *
+    * - Description: Initializes a new instance of `UAConfig` with specified settings for the upgrade alert.
     * - Parameters:
     *   - isRequired: A boolean indicating whether the upgrade is mandatory.
     *   - alertTitle: The title of the alert.
@@ -49,6 +55,7 @@ extension UAConfig {
    /**
     * Provides a default configuration for the alert.
     * This can be used when no specific configuration is provided.
+    * - Description: Returns a default `UAConfig` instance with predefined values for alert title, message, and button titles, suitable for general use cases where a specific configuration is not necessary.
     */
    public static let defaultConfig: UAConfig = {
       .init(

Sources/UpgradeAlert/helper/UAError.swift

@@ -2,24 +2,29 @@ import Foundation
 /**
  * Error type. So we can track if bundle id etc faults.
  * This enum is used to handle errors in a more structured way, allowing for better error handling and debugging.
+ * - Description: Enumerates the various errors that can occur within the UpgradeAlert system, providing specific types for different error scenarios to facilitate precise error handling.
  */
 public enum UAError: Error {
    /**
     * This error is thrown when the URL for the App Store is invalid.
+    * - Description: Occurs when the URL intended to direct to the App Store is malformed or not properly formatted, preventing navigation to the App Store page.
     */
    case invalidAppStoreURL
    /**
     * This error is thrown when a general URL is invalid.
+    * - Description: Occurs when a general URL that is not specifically for the App Store is malformed or not properly formatted, preventing proper URL navigation or usage.
     */
    case invalideURL
    /**
     * This error is thrown when the response from a request is invalid.
     * - Parameter description: Provides more details about the error.
+    * - Description: Provides a detailed explanation of what went wrong with the response, including specifics that can help in debugging the issue.
     */
    case invalidResponse(description: String)
    /**
     * This error is thrown when there is an issue with the bundle.
     * The desc parameter provides more details about the error.
+    * - Description: Indicates an error related to the application's bundle, such as missing required resources or incorrect configuration settings.
     */
    case bundleErr(desc: String)
 }

Sources/UpgradeAlert/helper/UAOutcome.swift

@@ -1,25 +1,30 @@
 import Foundation
 /**
  * This enum represents the possible outcomes of an upgrade alert.
+ * - Description: Enumerates the various outcomes that can occur after presenting an upgrade alert to the user, allowing for a structured response handling based on the user's decision or any error that might occur.
  * - Fixme: ⚠️️ Consider renaming the cases to: notNow, notNeeded, appStoreOpened for better clarity.
  * - Fixme: ⚠️️ Add more detailed documentation for each case.
  */
 public enum UAOutcome {
    /**
     * Represents the outcome where the app is up-to-date and no upgrade is needed.
+    * - Description: Indicates that the current version of the application is the latest available version, and no update action is required.
     */
    case updateNotNeeded
    /**
     * Represents the outcome where the user has chosen to defer the upgrade.
+    * - Description: Indicates that the user has chosen to delay the upgrade process, opting to not update the application at this time.
     */
    case notNow 
    /**
     * Represents the outcome where the user has opened the App Store to perform the upgrade.
+    * - Description: Indicates that the user has initiated the upgrade process by opening the App Store to download the latest version of the application.
     */
    case didOpenAppStoreToUpdate 
    /**
     * Represents the outcome where an error occurred during the upgrade process.
     * - Parameter error: The error that occurred during the upgrade process.
+    * - Description: Provides details about the specific error that prevented the upgrade process from completing successfully.
     */
    case error(error: UAError) 
 }