From e761cdaa597c74d1814a63d4c30d72d3140d4fbe Mon Sep 17 00:00:00 2001 From: Olivier Halligon Date: Sun, 16 Aug 2015 20:28:20 +0200 Subject: [PATCH] Add missing header docs --- OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h | 9 +++++++++ OHHTTPStubs/Sources/OHHTTPStubsResponse.h | 7 +++++++ 2 files changed, 16 insertions(+) diff --git a/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h b/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h index 09a1bcd9..09f218cf 100644 --- a/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h +++ b/OHHTTPStubs/Sources/Mocktail/OHHTTPStubs+Mocktail.h @@ -10,12 +10,21 @@ NS_ASSUME_NONNULL_BEGIN +/** + * Error codes for the OHHTTPStubs Mocktail category + */ typedef NS_ENUM(NSInteger, OHHTTPStubsMocktailError) { + /** The specified path does not exist */ OHHTTPStubsMocktailErrorPathDoesNotExist = 1, + /** The specified path was not readable */ OHHTTPStubsMocktailErrorPathFailedToRead, + /** The specified path is not a directory */ OHHTTPStubsMocktailErrorPathIsNotFolder, + /** The specified file is not a valid Mocktail file */ OHHTTPStubsMocktailErrorInvalidFileFormat, + /** The specified Mocktail file has invalid headers */ OHHTTPStubsMocktailErrorInvalidFileHeader, + /** An unexpected internal error occured */ OHHTTPStubsMocktailErrorInternalError }; diff --git a/OHHTTPStubs/Sources/OHHTTPStubsResponse.h b/OHHTTPStubs/Sources/OHHTTPStubsResponse.h index 2536aa9e..f96dfbf9 100644 --- a/OHHTTPStubs/Sources/OHHTTPStubsResponse.h +++ b/OHHTTPStubs/Sources/OHHTTPStubsResponse.h @@ -190,6 +190,13 @@ NS_ASSUME_NONNULL_BEGIN #pragma mark - Initializers /*! @name Initializers */ +/** + * Designated empty initializer + * + * @return An empty `OHHTTPStubsResponse` on which you need to set either an error or a statusCode, httpHeaders, inputStream and dataSize. + * + * @note This is not recommended to use this method directly. You should use `initWithInputStream:dataSize:statusCode:headers:` instead. + */ -(instancetype)init NS_DESIGNATED_INITIALIZER; /**