Add comments for ABI encoder methods

Author: yaroslavyaroslav

Sources/web3swift/EthereumABI/ABIElements.swift

@@ -200,10 +200,13 @@ extension ABI.Element.Constructor {
 }
 
 extension ABI.Element.Function {
+
+    /// Encode parameters of a given contract method
+    /// - Parameter parameters: Parameters to pass to Ethereum contract
+    /// - Returns: Encoded data 
     public func encodeParameters(_ parameters: [AnyObject]) -> Data? {
         guard parameters.count == inputs.count,
-              let data = ABIEncoder.encode(types: inputs, values: parameters)
-        else { return nil }
+              let data = ABIEncoder.encode(types: inputs, values: parameters) else { return nil }
         return methodEncoding + data
     }
 }

Sources/web3swift/EthereumABI/ABIEncoding.swift

@@ -131,6 +131,12 @@ extension ABIEncoder {
         return nil
     }
 
+
+    /// Encode Elements In Out
+    /// - Parameters:
+    ///   - types: Contract element InOut to encode
+    ///   - values: Contract values of a given element to encode
+    /// - Returns: Encoded data
     public static func encode(types: [ABI.Element.InOut], values: [AnyObject]) -> Data? {
         guard types.count == values.count else {return nil}
         let params = types.compactMap { (el) -> ABI.Element.ParameterType in
@@ -139,6 +145,12 @@ extension ABIEncoder {
         return encode(types: params, values: values)
     }
 
+
+    /// Encode Elements Prarmeter Type
+    /// - Parameters:
+    ///   - types: Contract parameters type to encode
+    ///   - values: Contract values of a given element to encode
+    /// - Returns: Encoded data
     public static func encode(types: [ABI.Element.ParameterType], values: [AnyObject]) -> Data? {
         guard types.count == values.count else {return nil}
         var tails = [Data]()