DEX-292 feat: added comments to iOS SDK

Author: kamal-skyflow

Sources/Skyflow/collect/CollectContainer.swift

@@ -7,19 +7,19 @@
 import Foundation
 import UIKit
 
-/// This is the description for CollectContainer Class
+/// Wraps all Collect Elements.
 public class CollectContainer: ContainerProtocol {}
 
 public extension Container {
 
     /**
-    This is the description for create method.
+    Creates a Collect Element.
 
     - Parameters:
-        - input: This is the description for input parameter.
-        - options: This is the description for options parameter.
+        - input: Collect Element input.
+        - options: Collect Element options.
 
-    - Returns: This is the description of what method returns.
+    - Returns: Returns the Collect Element.
     */
      func create(input: CollectElementInput, options: CollectElementOptions? = CollectElementOptions()) -> TextField where T: CollectContainer {
         var tempContextOptions = self.skyflow.contextOptions
@@ -34,11 +34,11 @@ public extension Container {
     }
 
     /**
-    This is the description for collect method.
+    Collects the data and sends it to the vault.
 
     - Parameters:
-        - callback: This is the description for callback parameter.
-        - options: This is the description for options parameter.
+        - callback: Implementation of Skyflow.Callback.
+        - options: Collects the data and sends it to the vault.
     */
     func collect(callback: Callback, options: CollectOptions? = CollectOptions()) where T: CollectContainer {
         var tempContextOptions = self.skyflow.contextOptions

Sources/Skyflow/collect/CollectOptions.swift

@@ -6,19 +6,19 @@
 
 import Foundation
 
-/// This is the description for CollectOptions Class
+/// Options for a Collect Element.
 public struct CollectOptions {
     var tokens: Bool
     var additionalFields: [String: Any]?
     var upsert: [[String: Any]]?
 
     /**
-    This is the description for container method.
+    Initializes the Collect options.
 
     - Parameters:
-        - tokens: This is the description for tokens parameter.
-        - additionalFields: This is the description for additionalFields parameter.
-        - upsert: This is the description for upsert paramter.
+        - tokens: If `true`, returns tokens for the collected data. Defaults to `true`.
+        - additionalFields: Additional, non-sensitive data to insert into the vault.
+        - upsert: Upsert configuration for the element.
     */
     public init(tokens: Bool = true, additionalFields: [String: Any]? = nil, upsert: [[String:  Any]]? = nil) {
         self.tokens = tokens

Sources/Skyflow/collect/InsertOptions.swift

@@ -6,17 +6,17 @@
 
 import Foundation
 
-/// This is the description for InsertOptions Class
+/// Contains additional parameters for the insert method.
 public struct InsertOptions {
     var tokens: Bool
     var upsert: [[String: Any]]?
 
     /**
-    This is the description for container method.
+    Initializes the Insert options.
 
     - Parameters:
-        - tokens: This is the description for tokens parameter.
-        - upsert: This is the description for upsert parameter.
+        - tokens: If `true`, returns tokens for the collected data. Defaults to `false`.
+        - upsert: If specified, upserts data. If not specified, inserts data.
     */
     public init(tokens: Bool = true, upsert: [[String:  Any]]? = nil) {
         self.tokens = tokens

Sources/Skyflow/core/Client.swift

@@ -16,10 +16,10 @@ public class Client {
     var elementLookup: [String: Any] = [:]
 
     /**
-    This is the description for init method.
+    Initializes the Skyflow client.
 
     - Parameters:
-        - skyflowConfig: This is the description for skyflowConfig parameter.
+        - skyflowConfig: Configuration for the Skyflow client.
     */
     public init(_ skyflowConfig: Configuration) {
         self.vaultID = skyflowConfig.vaultID
@@ -30,12 +30,12 @@ public class Client {
     }
 
     /**
-    This is the description for insert method.
+    Inserts data into the vault.
 
     - Parameters:
-        - records: This is the description for records parameter.
-        - options: This is the description for options parameter.
-        - callback: This is the description for callback parameter.
+        - records: Records to insert.
+        - options: Options for the insertion.
+        - callback: Implementation of Skyflow.Callback.
     */
     public func insert(records: [String: Any], options: InsertOptions = InsertOptions(), callback: Callback) {
         var tempContextOptions = self.contextOptions
@@ -111,13 +111,13 @@ public class Client {
     }
 
     /**
-    This is the description for container method.
+    Creates a container.
 
     - Parameters:
-        - type: This is the description for type parameter.
-        - options: This is the description for options parameter.
+        - type: Type of the container.
+        - options: Options for the container.
 
-    - Returns: This is the description of what method returns.
+    - Returns: Returns a container of the specified type.
     */
     public func container<T>(type: T.Type, options: ContainerOptions? = ContainerOptions()) -> Container<T>? {
         if options != nil {
@@ -138,12 +138,12 @@ public class Client {
     }
 
     /**
-    This is the description for detokenize method.
+    Returns values that correspond to the specified tokens.
 
     - Parameters:
-        - records: This is the description for records parameter.
-        - options: This is the description for options parameter.
-        - callback: This is the description for callback paramter.
+        - records: Records to fetch.
+        - options: Additional options for the reveal method.
+        - callback: Implementation of Skyflow.Callback.
     */
     public func detokenize(records: [String: Any], options: RevealOptions? = RevealOptions(), callback: Callback) {
         var tempContextOptions = self.contextOptions
@@ -210,11 +210,11 @@ public class Client {
     }
 
     /**
-    This is the description for getById method.
+    Reveal records by Skyflow ID.
 
     - Parameters:
         - records: This is the description for records parameter.
-        - callback: This is the description for callback paramter.
+        - callback: Implementation of Skyflow.Callback.
     */
     public func getById(records: [String: Any], callback: Callback) {
         var tempContextOptions = self.contextOptions

Sources/Skyflow/core/Configuration.swift

@@ -6,7 +6,7 @@
 
 import Foundation
 
-/// This is the description for Configuration method.
+/// Configuration for the Skyflow client.
 public struct Configuration {
     var vaultID: String
     var vaultURL: String
@@ -17,10 +17,10 @@ public struct Configuration {
     This is the description for init method.
 
     - Parameters:
-        - vaultID: This is the description for vaultID parameter.
-        - vaultURL: This is the description for vaultURL parameter.
-        - tokenProvider: This is the description for tokenProvider paramter.
-        - options: This is the description for options parameter.
+        - vaultID: ID of the vault to connect to.
+        - vaultURL: URL of the vault to connect to.
+        - tokenProvider: An implementation of the token provider interface.
+        - options: Additional options for configuration.
     */
     public init(vaultID: String = "", vaultURL: String = "", tokenProvider: TokenProvider, options: Options? = Options()) {
         self.vaultID = vaultID

Sources/Skyflow/core/Env.swift

@@ -6,7 +6,7 @@
 
 import Foundation
 
-/// This is the description for Env enum.
+/// Supported environments.
 public enum Env {
     case DEV
     case PROD

Sources/Skyflow/core/EventName.swift

@@ -6,7 +6,7 @@
 
 import Foundation
 
-/// This is the description for EventName enum.
+/// Supported event names.
 public enum EventName: String {
     case CHANGE = "CHANGE"
     case READY = "READY"

Sources/Skyflow/core/Init.swift

@@ -7,12 +7,12 @@
 import Foundation
 
 /**
-This is the description for initialize method.
+Initializes the Skyflow client.
 
 - Parameters:
-    - skyflowConfig: This is the description for skyflowConfig parameter.
+    - skyflowConfig: Configuration for the Skyflow client.
 
-- Returns: This is the description of what method returns.
+- Returns: Returns an instance of the Skyflow client.
 */
 public func initialize(_ skyflowConfig: Configuration) -> Client {
     return Client(skyflowConfig)

Sources/Skyflow/core/LogLevel.swift

@@ -6,7 +6,7 @@
 
 import Foundation
 
-/// This is the description for LogLevel enum.
+/// Supported log levels.
 public enum LogLevel: Int {
     case DEBUG = 0
     case INFO = 1

Sources/Skyflow/core/Options.swift

@@ -5,17 +5,17 @@
 /// Object that describes the options parameter
 
 public struct Options {
-    /// This is the description for logLevel property.
+    /// Log level to apply. 
     var logLevel: LogLevel
-    /// This is the description for env property.
+    /// Type of environment.
     var env: Env
 
     /**
-    This is the description for init method.
+    Initializes the Skyflow client.
 
     - Parameters:
-        - logLevel: This is the description for logLevel parameter.
-        - env: This is the description for env parameter.
+        - logLevel: Log level to apply.
+        - env: Type of environment.
     */
     public init(logLevel: LogLevel = .ERROR, env: Env = .PROD) {
         self.logLevel = logLevel