Add Swift Documentation

Author: Andrea-Scuderi

Sources/LambdaSwiftSprinterNioPlugin/LambdaApiNIO.swift

@@ -22,22 +22,45 @@ import NIO
 import NIOHTTP1
 import NIOFoundationCompat
 
+/**
+`SprinterNIO` implements the AWS Lambda Custom Runtime with `SwiftNIO`
+*/
 public typealias SprinterNIO = Sprinter<LambdaApiNIO>
 
+
+/**
+ SprinterNIOError
+ An error related to the `SprinterNIO`
+ 
+  ### Errors: ###
+ ```
+ case invalidResponse(HTTPResponseStatus)
+ case invalidBuffer
+ ```
+ */
 public enum SprinterNIOError: Error {
+    
+    /// Invalid Reponse with `HTTPResponseStatus`
     case invalidResponse(HTTPResponseStatus)
+    
+    /// Invalid Buffer
     case invalidBuffer
 }
 
+/** The amount of time the lambda waits for the next event.
+ 
+ The `default` timeout for a Lambda is `3600` seconds.
+*/
 public var lambdaRuntimeTimeout: TimeAmount = .seconds(3600)
+
+/// The timeout used to create the instance of the `httpClient`
 public var timeout = HTTPClient.Configuration.Timeout(connect: lambdaRuntimeTimeout,
                                                       read: lambdaRuntimeTimeout)
 
-public var httpClient: HTTPClientProtocol = {
-    let configuration = HTTPClient.Configuration(timeout: timeout)
-    return HTTPClient(eventLoopGroupProvider: .createNew, configuration: configuration)
-}()
-
+/** The HTTPClientProtocol defines a generic httpClient
+ 
+ Required for Unit Testing
+*/
 public protocol HTTPClientProtocol: class {
     var eventLoopGroup: EventLoopGroup { get }
     func get(url: String, deadline: NIODeadline?) -> EventLoopFuture<HTTPClient.Response>
@@ -46,6 +69,16 @@ public protocol HTTPClientProtocol: class {
     func syncShutdown() throws
 }
 
+
+/** The httpClient implementing `HTTPClientProtocol`
+ 
+ The `default` implementation is an `HTTPClient` defined in `AsyncHTTPClient`
+*/
+public var httpClient: HTTPClientProtocol = {
+    let configuration = HTTPClient.Configuration(timeout: timeout)
+    return HTTPClient(eventLoopGroupProvider: .createNew, configuration: configuration)
+}()
+
 extension HTTPClient: HTTPClientProtocol {
 
 }

Sources/LambdaSwiftSprinterNioPlugin/NIOLambdaHandler.swift

@@ -21,8 +21,8 @@ import LambdaSwiftSprinter
 /**
  `SyncCodableNIOLambda<Event: Decodable, Response: Encodable>` lambda handler typealias.
 
- - Usage example:
- 
+ ### Usage Example: ###
+
  ```
  import AsyncHTTPClient
  import Foundation
@@ -74,7 +74,7 @@ public typealias SyncCodableNIOLambda<Event: Decodable, Response: Encodable> = (
 /**
  `SyncDictionaryNIOLambda` lambda handler typealias.
 
- - Usage example:
+ ### Usage Example: ###
 
  ```
  import AsyncHTTPClient
@@ -188,8 +188,7 @@ public typealias AsyncCodableNIOLambda<Event: Decodable, Response: Encodable> =
 /**
  `AsyncDictionaryNIOLambda` lambda handler typealias.
 
- - Usage example:
- 
+ ### Usage Example: ###
  ```
  import AsyncHTTPClient
  import Foundation