From 29e51503377694ea27e9bc56223eb0bf5b9afbcd Mon Sep 17 00:00:00 2001 From: Ivan Smolin Date: Fri, 27 Oct 2017 21:32:31 +0300 Subject: [PATCH] add comments --- Sources/Enums/LeadKitError.swift | 2 +- Sources/Enums/RequestError.swift | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Sources/Enums/LeadKitError.swift b/Sources/Enums/LeadKitError.swift index d2aa0d51..de264fac 100644 --- a/Sources/Enums/LeadKitError.swift +++ b/Sources/Enums/LeadKitError.swift @@ -22,7 +22,7 @@ import Foundation -/// Enum which represents common errors in LeadKit framework +/// Enum that represents common errors in LeadKit framework /// /// - failedToCastValue: attempt to cast was failed public enum LeadKitError: Error { diff --git a/Sources/Enums/RequestError.swift b/Sources/Enums/RequestError.swift index aa52a60d..1b1c7259 100644 --- a/Sources/Enums/RequestError.swift +++ b/Sources/Enums/RequestError.swift @@ -22,9 +22,16 @@ import Alamofire +/// Enum that represents general api request errors +/// +/// - noConnection: No connection to the server (no internet connection, or connection timed out error) +/// - network: Unknown network-related error. +/// - invalidResponse: Invalid server response (response serialization or validation errors). +/// This includes unacceptable status codes (500, etc), json serialization errors, etc. +/// - mapping: Errors that occurs during mapping json into model. public enum RequestError: Error { - case noConnection // no connection to the server + case noConnection case network(error: Error) case invalidResponse(error: AFError) case mapping(error: Error, response: Any)