Add missing header docs

AliSoftware · Aug 16, 2015 · e761cda · e761cda
1 parent 801483d
commit e761cda
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git 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
@@ -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;
 
 /**