Merge pull request #22 from AppcentMobile/feature/documentation

Feature/documentation

Author: burakcolakappcent

Sources/ACMOpenAI/ACMOpenAI.swift

@@ -1,6 +1,19 @@
+//
+//  ACMOpenAI.swift
+//
+
+/// Starting point of Open AI SDK
 public struct ACMOpenAI {
+    /// Base init
     public init() {}
 
+    /// Generic manager for creating API managers
+    ///
+    /// - Parameters:
+    ///     - item: T<Generic>
+    ///
+    /// - Returns:
+    ///     - T -> Generic
     public func manager<T: BaseAPIManager>(item: T.Type) -> T {
         return item.init()
     }

Sources/ACMOpenAI/Callbacks/Audio/AudioCallback.swift

@@ -2,9 +2,12 @@
 //  AudioCallback.swift
 //
 
+/// Callback for holding audio endpoint
 public struct AudioCallback {}
 
 public extension AudioCallback {
+    /// Create transcriptions typealias
     typealias CreateTranscriptions = ((ACMOAIAudioResponse.CreateTranscriptions?) -> Void)?
+    /// Create translations typealias
     typealias CreateTranslations = ((ACMOAIAudioResponse.CreateTranslations?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Chat/ChatCallback.swift

@@ -2,8 +2,10 @@
 //  ChatCallback.swift
 //
 
+/// Callback for holding chat endpoint
 public struct ChatCallback {}
 
 public extension ChatCallback {
+    /// Create chat typealias
     typealias Create = ((ACMOAIChatResponse.Create?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Completions/CompletionsCallback.swift

@@ -2,8 +2,10 @@
 //  CompletionsCallback.swift
 //
 
+/// Callback for holding completions endpoint
 public struct CompletionsCallback {}
 
 public extension CompletionsCallback {
+    /// Create completions typealias
     typealias Create = ((ACMOAICompletionsResponse.Create?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Edits/EditsCallback.swift

@@ -2,8 +2,10 @@
 //  EditsCallback.swift
 //
 
+/// Callback for holding edits endpoint
 public struct EditsCallback {}
 
 public extension EditsCallback {
+    /// Create edits typealias
     typealias Create = ((ACMOAIEditsResponse.Create?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Embeddings/EmbeddingsCallback.swift

@@ -2,8 +2,10 @@
 //  EmbeddingsCallback.swift
 //
 
+/// Callback for holding embeddings endpoint
 public struct EmbeddingsCallback {}
 
 public extension EmbeddingsCallback {
+    /// Create embeddings typealias
     typealias Create = ((ACMOAIEmbeddingsResponse.Create?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Engines/EnginesCallback.swift

@@ -2,9 +2,12 @@
 //  EnginesCallback.swift
 //
 
+/// Callback for holding engines endpoint
 public struct EnginesCallback {}
 
 public extension EnginesCallback {
+    /// List engines typealias
     typealias List = ((ACMOAIEnginesResponse.List?) -> Void)?
+    /// Retrieve engines typealias
     typealias Retrieve = ((ACMOAIEnginesResponse.Retrieve?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Files/FilesCallback.swift

@@ -2,12 +2,18 @@
 //  FilesCallback.swift
 //
 
+/// Callback for holding files endpoint
 public struct FilesCallback {}
 
 public extension FilesCallback {
+    /// List files typealias
     typealias List = ((ACMOAIFilesResponse.List?) -> Void)?
+    /// Upload files typealias
     typealias Upload = ((ACMOAIFilesResponse.Upload?) -> Void)?
+    /// Delete files typealias
     typealias Delete = ((ACMOAIFilesResponse.Delete?) -> Void)?
+    /// Retrieve files typealias
     typealias Retrieve = ((ACMOAIFilesResponse.Retrieve?) -> Void)?
+    /// Retrieve content files typealias
     typealias RetrieveContent = ((String?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/FineTunes/FineTunesCallback.swift

@@ -2,13 +2,20 @@
 //  FineTunesCallback.swift
 //
 
+/// Callback for holding fine tunes endpoint
 public struct FineTunesCallback {}
 
 public extension FineTunesCallback {
+    /// Create fine tunes typealias
     typealias Create = ((ACMOAIFineTunesResponse.Create?) -> Void)?
+    /// List fine tunes typealias
     typealias List = ((ACMOAIFineTunesResponse.List?) -> Void)?
+    /// Retrieve fine tunes typealias
     typealias Retrieve = ((ACMOAIFineTunesResponse.Retrieve?) -> Void)?
+    /// Cancel fine tunes typealias
     typealias Cancel = ((ACMOAIFineTunesResponse.Cancel?) -> Void)?
+    /// List events fine tunes typealias
     typealias ListEvents = ((ACMOAIFineTunesResponse.ListEvents?) -> Void)?
+    /// Delete fine tunes typealias
     typealias Delete = ((ACMOAIFineTunesResponse.Delete?) -> Void)?
 }

Sources/ACMOpenAI/Callbacks/Images/ImagesCallback.swift

@@ -1,12 +1,15 @@
 //
 //  ImagesCallback.swift
 //
-//
 
+/// Callback for holding images endpoint
 public struct ImagesCallback {}
 
 public extension ImagesCallback {
+    /// Create images typealias
     typealias Create = ((ACMOAIImagesResponse.Create?) -> Void)?
+    /// Create edit images typealias
     typealias CreateEdit = ((ACMOAIImagesResponse.CreateEdit?) -> Void)?
+    /// Create variation images typealias
     typealias CreateVariation = ((ACMOAIImagesResponse.CreateVariation?) -> Void)?
 }