Documentation fixes

Author: lightsprint09

Source/BasicNetworkService.swift

@@ -40,10 +40,9 @@ public final class BasicNetworkService: NetworkService {
     let networkResponseProcessor: NetworkResponseProcessor
 
     /**
-     Creates an `BasicNetworkService` instance with a given networkAccess and a map of endPoints
+     Creates an `BasicNetworkService` instance with a given network access to execute requests on.
 
      - parameter networkAccess: provides basic access to the network.
-     - parameter endPoints: map of baseURLKey -> baseURLs
      */
     public init(networkAccess: NetworkAccess) {
         self.networkAccess = networkAccess
@@ -54,7 +53,7 @@ public final class BasicNetworkService: NetworkService {
      Fetches a resource asynchronously from remote location. Execution of the requests starts immediately.
      Execution happens on no specific queue. It dependes on the network access which queue is used.
      Once execution is finished either the completion block or the error block gets called.
-     You can decide on which queue these blocks get called.
+     You decide on which queue these blocks get executed.
 
      **Example**:
      ```swift
@@ -68,7 +67,7 @@ public final class BasicNetworkService: NetworkService {
      })
      ```
 
-     - parameter queue: The DispatchQueue to execute the completion and error block on.
+     - parameter queue: The `DispatchQueue` to execute the completion and error block on.
      - parameter resource: The resource you want to fetch.
      - parameter onCompletionWithResponse: Callback which gets called when fetching and transforming into model succeeds.
      - parameter onError: Callback which gets called when fetching or transforming fails.

Source/ModifyRequestNetworkService.swift

@@ -25,7 +25,7 @@ import Foundation
 import Dispatch
 
 /**
- `ModifyRequestNetworkService` can be composed with a networkService to modify all outgoing requests.
+ `ModifyRequestNetworkService` can be composed with a network service to modify all outgoing requests.
  One could add auth tokens or API keys for specifics URLs.
 
  **Example**:
@@ -58,7 +58,7 @@ public final class ModifyRequestNetworkService: NetworkService {
      Fetches a resource asynchronously from remote location. Execution of the requests starts immediately.
      Execution happens on no specific queue. It dependes on the network access which queue is used.
      Once execution is finished either the completion block or the error block gets called.
-     You can decide on which queue these blocks get called.
+     You decide on which queue these blocks get executed.
 
      **Example**:
      ```swift
@@ -72,7 +72,7 @@ public final class ModifyRequestNetworkService: NetworkService {
      })
      ```
 
-     - parameter queue: The DispatchQueue to execute the completion and error block on.
+     - parameter queue: The `DispatchQueue` to execute the completion and error block on.
      - parameter resource: The resource you want to fetch.
      - parameter onCompletionWithResponse: Callback which gets called when fetching and transforming into model succeeds.
      - parameter onError: Callback which gets called when fetching or transforming fails.

Source/NetworkResponseProcessor.swift

@@ -62,7 +62,7 @@ final class NetworkResponseProcessor {
     /// The result will be return via a blocks onCompletion/onError.
     ///
     /// - Parameters:
-    ///   - queue: The DispatchQueue to execute the completion and error block on.
+    ///   - queue: The `DispatchQueue` to execute the completion and error block on.
     ///   - response: the HTTPURLResponse one wants to parse.
     ///   - resource: the resource.
     ///   - data: the payload of the response.

Source/NetworkService.swift

@@ -35,7 +35,7 @@ public protocol NetworkService {
      Fetches a resource asynchronously from remote location. Execution of the requests starts immediately.
      Execution happens on no specific queue. It dependes on the network access which queue is used.
      Once execution is finished either the completion block or the error block gets called.
-     You can decide on which queue these blocks get called.
+     You decide on which queue these blocks get executed.
 
      **Example**:
      ```swift
@@ -49,7 +49,7 @@ public protocol NetworkService {
      })
      ```
 
-     - parameter queue: The DispatchQueue to execute the completion and error block on.
+     - parameter queue: The `DispatchQueue` to execute the completion and error block on.
      - parameter resource: The resource you want to fetch.
      - parameter onCompletionWithResponse: Callback which gets called when fetching and transforming into model succeeds.
      - parameter onError: Callback which gets called when fetching or transforming fails.

Source/NetworkServiceMock.swift

@@ -85,7 +85,7 @@ public final class NetworkServiceMock: NetworkService {
      Fetches a resource asynchronously from remote location. Execution of the requests starts immediately.
      Execution happens on no specific queue. It dependes on the network access which queue is used.
      Once execution is finished either the completion block or the error block gets called.
-     You can decide on which queue these blocks get called.
+     You decide on which queue these blocks get executed.
 
      **Example**:
      ```swift
@@ -99,7 +99,7 @@ public final class NetworkServiceMock: NetworkService {
      })
      ```
 
-     - parameter queue: The DispatchQueue to execute the completion and error block on.
+     - parameter queue: The `DispatchQueue` to execute the completion and error block on.
      - parameter resource: The resource you want to fetch.
      - parameter onCompletionWithResponse: Callback which gets called when fetching and transforming into model succeeds.
      - parameter onError: Callback which gets called when fetching or transforming fails.

Source/Resource+Inspect.swift

@@ -26,7 +26,7 @@ extension Resource {
 
      ```swift
      let resource: Resource<Train> = //
-     resource.inspectData({ data in
+     resource.inspectData { data in
         print(String(bytes: data, encoding: .utf8))
      }
      ```

Source/Resource.swift

@@ -24,13 +24,20 @@
 /**
  `Resource` describes a remote resource of generic type.
  The type can be fetched via HTTP(S) and parsed into the coresponding model object.
+ 
+ **Example**:
+ ```swift
+ let request: URLRequest = //
+ let resource: Resource<String> = Resource(request: request, parse: { data in
+    String(data: data, encoding: .utf8)
+ })
+ ```
  */
 public struct Resource<Model> {
     /// The request to fetch the resource remote payload
     public let request: URLRequestConvertible
-    /**
-     Parses data into given Model
-     */
+    
+    /// Parses data into given model.
     public let parse: (_ data: Data) throws -> Model
 
     /// Creates a type safe resource, which can be used to fetch it with `NetworkService`

Source/RetryNetworkService.swift

@@ -61,7 +61,7 @@ public final class RetryNetworkService: NetworkService {
      Fetches a resource asynchronously from remote location. Execution of the requests starts immediately.
      Execution happens on no specific queue. It dependes on the network access which queue is used.
      Once execution is finished either the completion block or the error block gets called.
-     You can decide on which queue these blocks get called.
+     You decide on which queue these blocks get executed.
 
      **Example**:
      ```swift
@@ -75,7 +75,7 @@ public final class RetryNetworkService: NetworkService {
      })
      ```
 
-     - parameter queue: The DispatchQueue to execute the completion and error block on.
+     - parameter queue: The `DispatchQueue` to execute the completion and error block on.
      - parameter resource: The resource you want to fetch.
      - parameter onCompletionWithResponse: Callback which gets called when fetching and transforming into model succeeds.
      - parameter onError: Callback which gets called when fetching or transforming fails.

Source/URLRequestConvertible+Modifications.swift

@@ -41,7 +41,7 @@ public extension URLRequestConvertible {
     /// Creates a new `URLRequestConvertible` with query items appended to the new request.
     ///
     /// - Parameter queryItems: the query items to append to the request
-    /// - Parameter overrideExisting: if true existing items with the same name will be overridden
+    /// - Parameter overrideExisting: if `true existing items with the same name will be overridden
     /// - Returns: a new `URLRequestConvertible`
     func appending(queryItems: [URLQueryItem], overrideExisting: Bool = true) -> URLRequestConvertible {
         var request = asURLRequest()
@@ -55,15 +55,15 @@ public extension URLRequestConvertible {
     /// Creates a new `URLRequestConvertible` with query parameters appended to the new request.
     ///
     /// - Parameter queryParameters: the parameters to append to the request
-    /// - Parameter overrideExisting: if true existing items with the same name will be overridden
+    /// - Parameter overrideExisting: if `true existing items with the same name will be overridden
     /// - Returns: a new `URLRequestConvertible`
     func appending(queryParameters: [String: String], overrideExisting: Bool = true) -> URLRequestConvertible {
         return appending(queryItems: queryParameters.asURLQueryItems() )
     }
 
     /// Creates a new `URLRequestConvertible` with all existing query items replaced with new ones.
     ///
-    /// - Parameter queryItems: the queryItems to add to the request
+    /// - Parameter queryItems: the query items to add to the request
     /// - Returns: a new `URLRequestConvertible`
     func replacingAllQueryItems(with queryItems: [URLQueryItem]) -> URLRequestConvertible {
         var request = asURLRequest()

Source/URLRequestConvertible.swift

@@ -45,12 +45,12 @@ extension URLRequest {
     /// Convience initializer for easy request creation.
     ///
     /// - Parameters:
-    ///   - path: path to the resource
-    ///   - baseURL: the base url of the resource
-    ///   - HTTPMethod: the HTTP method for the request
-    ///   - parameters: url parameters for the request
-    ///   - body: body data payload
-    ///   - allHTTPHeaderFields: HTTP request header fields
+    ///   - path: path to the resource.
+    ///   - baseURL: the base url of the resource.
+    ///   - HTTPMethod: the HTTP method for the request. Defaults to `.GET`
+    ///   - parameters: url parameters for the request. Defaults to `nil`
+    ///   - body: body data payload. Defaults to `nil`
+    ///   - allHTTPHeaderFields: HTTP request header fields. Defaults to `nil`
     ///
     /// - Important: path must not start with a `/`
     public init(path: String, baseURL: URL,