Update OpenAIDefaultLoader.swift

Author: swiftuiux

Sources/openai-async-image-swiftui/viewModel/OpenAIDefaultLoader.swift

@@ -1,6 +1,6 @@
 //
 //  OpenAIViewModel.swift
-//  
+//
 //
 //  Created by Igor on 28.02.2023.
 //
@@ -19,13 +19,14 @@ import AppKit.NSImage
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
 public final class OpenAIDefaultLoader : IOpenAILoader{
 
-    /// Http async client
+    /// HTTP async client to handle requests
     private let client : Http.Proxy<JsonReader, JsonWriter>?
 
-    /// Set of params for making requests
+    /// Endpoint parameters required for making requests
     private let endpoint : IOpenAIImageEndpoint
 
-    /// - Parameter endpoint: Set of params for making requests
+    /// Initializes the loader with endpoint parameters
+    /// - Parameter endpoint: Set of parameters for making requests
     public init(endpoint : IOpenAIImageEndpoint) {
 
         self.endpoint = endpoint
@@ -38,33 +39,37 @@ public final class OpenAIDefaultLoader : IOpenAILoader{
         client = Http.Proxy(baseURL: url)
     }
 
-    /// Load image by text
+    /// Loads an image from the OpenAI API based on a text prompt
     /// - Parameters:
-    ///   - prompt: Text
-    ///   - size: Image size
-    /// - Returns: Open AI Image
+    ///   - prompt: The text prompt describing the desired image
+    ///   - size: The size of the generated image
+    /// - Returns: OpenAI Image
     public func load(
         _ prompt : String,
         with size : OpenAIImageSize
     ) async throws -> Image{
 
+        // Prepare the request body with the prompt and size
         let body = Input(prompt: prompt, size: size, response_format: .b64, n: 1)
 
+        // Set the request headers, including authorization
         let headers = ["Content-Type": "application/json","Authorization": "Bearer \(endpoint.apiKey)"]
         let path = endpoint.path
 
         guard let client = client else{
             throw AsyncImageErrors.clientIsNotDefined
         }
 
+        // Send the request and get the response
         let result: Http.Response<Output> = try await client.post(path: path, body: body, headers: headers)
 
+        // Convert the response to an image
         return try imageBase64(from: result.value)
     }
 
-    /// Decode base64 to Data
-    /// - Parameter output: Received format from the endpoint
-    /// - Returns: Decoded data
+    /// Decodes base64 encoded string to Data
+    /// - Parameter output: The output received from the endpoint
+    /// - Returns: Decoded Data
     private func decodeBase64(from output: Output) throws -> Data?{
         guard let base64 = output.firstImage else  {
             throw AsyncImageErrors.returnedNoImages
@@ -74,7 +79,7 @@ public final class OpenAIDefaultLoader : IOpenAILoader{
     }
 
 #if os(iOS) || os(watchOS) || os(tvOS)
-    /// Base64 encoder for iOS
+    /// Converts base64 encoded string to UIImage for iOS
     /// - Parameter output: OpenAI response type
     /// - Returns: UIImage
     private func imageBase64(from output: Output) throws -> Image {
@@ -90,7 +95,7 @@ public final class OpenAIDefaultLoader : IOpenAILoader{
 #endif
 
 #if os(macOS)
-    /// Base64 encoder for macOS
+    /// Converts base64 encoded string to NSImage for macOS
     /// - Parameter output: OpenAI response type
     /// - Returns: NSImage
     private func imageBase64(from output: Output) throws -> Image {