update

Author: swiftuiux

Sources/openai-async-image-swiftui/enum/AsyncImageErrors.swift

@@ -7,17 +7,17 @@
 
 import Foundation
 
-/// Set of errors for ``OpenAIAsyncImage``
+/// Enumeration representing the various errors that can occur in `OpenAIAsyncImage`
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-enum AsyncImageErrors: Error, Equatable{
+enum AsyncImageErrors: Error, Equatable {
 
-    /// Could not create Image from uiImage
+    /// Error indicating that an image could not be created from a `uiImage`
     case imageInit
 
-    /// Client not found - the reason url in not valid
+    /// Error indicating that the client was not found, likely due to an invalid URL
     case clientIsNotDefined
 
-    /// response returned no images
+    /// Error indicating that the response returned no images
     case returnedNoImages
 
 }

Sources/openai-async-image-swiftui/enum/ImageState.swift

@@ -7,17 +7,16 @@
 
 import SwiftUI
 
-/// Set of states  for ``OpenAIAsyncImage``
+/// Enumeration representing the various states of `OpenAIAsyncImage`
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-public enum ImageState{
+public enum ImageState {
 
-    /// Loading currently
+    /// State when the image is currently being loaded
     case loading
 
-    /// Loaded
+    /// State when the image has been successfully loaded
     case loaded(Image)
 
-    /// There's an error happened while fetching
+    /// State when an error occurred during image fetching
     case loadError(Error)
-    
 }

Sources/openai-async-image-swiftui/model/Output.swift

@@ -7,22 +7,24 @@
 
 import Foundation
 
-/// Output format for OpenAI API
+/// Structure representing the output format for the OpenAI API response
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-struct Output: Decodable{
+struct Output: Decodable {
 
-    /// Date and time
-    let created : Int
+    /// The creation date and time of the response in UNIX timestamp format
+    let created: Int
 
-    /// Set of images
+    /// An array of base64 encoded images
     let data: [Base64]
 
-    /// Fist image from the received data set
-    var firstImage : String?{
+    /// The first image from the received data set, if available
+    var firstImage: String? {
         data.first?.b64_json
     }
 }
 
-struct Base64: Decodable{
-    let b64_json : String
+/// Structure representing a base64 encoded image
+struct Base64: Decodable {
+    /// The base64 encoded image data in JSON format
+    let b64_json: String
 }

Sources/openai-async-image-swiftui/net/OpenAIImageEndpoint.swift

@@ -7,45 +7,47 @@
 
 import Foundation
 
-/// Set of specs for access to OpenAPI image resource
+/// Struct providing specifications for accessing the OpenAI image resource
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-public struct OpenAIImageEndpoint: IOpenAIImageEndpoint{
+public struct OpenAIImageEndpoint: IOpenAIImageEndpoint {
 
-    // MARK: - Static
+    // MARK: - Static Properties
 
-    /// Base url to OpenAPI image resource
+    /// Static base URL for the OpenAI image resource
     public static var urlString = "https://api.openai.com"
 
-    /// Path to the point
+    /// Static path to the specific endpoint for generating images
     public static var path = "/v1/images/generations"
 
-    /// - Parameter apiKey: Api key for access
-    /// - Returns: Endpoint
-    static public func get(with apiKey: String) -> Self{
+    /// Creates an instance of `OpenAIImageEndpoint` with the provided API key
+    /// - Parameter apiKey: API key for accessing the OpenAI API
+    /// - Returns: Configured instance of `OpenAIImageEndpoint`
+    public static func get(with apiKey: String) -> Self {
         .init(
             urlString: Self.urlString,
             apiKey: apiKey,
-            path: Self.path)
+            path: Self.path
+        )
     }
 
-    // MARK: - Config
+    // MARK: - Instance Properties
 
-    /// Base url to OpenAPI image resource
+    /// Base URL for the OpenAI image resource
     public let urlString: String
 
-    /// Path to the point
-    public let path : String
+    /// Path to the specific endpoint
+    public let path: String
 
-    /// Api key for access
-    public let apiKey : String
+    /// API key for authentication and access to the OpenAI API
+    public let apiKey: String
 
-    // MARK: - Life circle
+    // MARK: - Initializer
 
+    /// Initializes a new instance of `OpenAIImageEndpoint`
     /// - Parameters:
-    ///   - urlString: Base url to OpenAPI image resource
-    ///   - httpMethod: Http method
-    ///   - apiKey: Api key for access
-    ///   - path: Path to the point
+    ///   - urlString: Base URL for the OpenAI image resource
+    ///   - apiKey: API key for accessing the OpenAI API
+    ///   - path: Path to the specific endpoint
     public init(urlString: String, apiKey: String, path: String) {
         self.urlString = urlString
         self.apiKey = apiKey

Sources/openai-async-image-swiftui/protocol/IOpenAIImageEndpoint.swift

@@ -7,18 +7,17 @@
 
 import Foundation
 
-/// Defines access API to OpenAI image API
+/// Protocol defining access to the OpenAI image API
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-public protocol IOpenAIImageEndpoint{
+public protocol IOpenAIImageEndpoint {
 
-    /// Base url to OpenAPI image resource
-    var urlString : String { get }
+    /// Base URL for the OpenAI image resource
+    var urlString: String { get }
 
-    /// Path to the point
-    var path : String { get }
-    
-    /// Api key for access
-    var apiKey : String { get }
+    /// Path to the specific endpoint within the OpenAI API
+    var path: String { get }
 
+    /// API key for authentication and access to the OpenAI API
+    var apiKey: String { get }
 
 }

Sources/openai-async-image-swiftui/protocol/IOpenAILoader.swift

@@ -7,14 +7,14 @@
 
 import SwiftUI
 
-/// Loader for getting images
+/// Protocol defining the loader for fetching images from the OpenAI API
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
-public protocol IOpenAILoader{
+public protocol IOpenAILoader {
 
-    /// Load image by text
+    /// Asynchronously loads an image based on a provided text prompt and size
     /// - Parameters:
-    ///   - prompt: Text
-    ///   - size: Image size
-    /// - Returns: Open AI Image
-    func load(_ prompt : String, with size : OpenAIImageSize) async throws  -> Image
+    ///   - prompt: The text prompt describing the desired image
+    ///   - size: The size of the generated image
+    /// - Returns: The generated OpenAI image
+    func load(_ prompt: String, with size: OpenAIImageSize) async throws -> Image
 }