@@ -111,7 +111,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
111111
112112 /* *
113113 * Create a new model instance and initialize it with the JSON from a text parameter. The method assumes UTF8 encoded input text.
114- * @param s JSON text data
114+ * @param string JSON text data
115115 * @param err an initialization error or nil
116116 * @exception JSONModelTypeNotAllowedException thrown when unsported type is found in the incoming JSON,
117117 * or a property type in your model is not supported by JSONValueTransformer and its categories
@@ -121,7 +121,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
121121
122122 /* *
123123 * Create a new model instance and initialize it with the JSON from a text parameter using the given encoding.
124- * @param s JSON text data
124+ * @param string JSON text data
125125 * @param encoding the text encoding to use when parsing the string (see NSStringEncoding)
126126 * @param err an initialization error or nil
127127 * @exception JSONModelTypeNotAllowedException thrown when unsported type is found in the incoming JSON,
@@ -148,7 +148,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
148148 * of model objects. Handy when importing JSON data lists.
149149 * This method will loop over the input list and initialize a data model for every dictionary in the list.
150150 *
151- * @param a list of dictionaries to be imported as models
151+ * @param array list of dictionaries to be imported as models
152152 * @return list of initialized data model objects
153153 * @exception JSONModelTypeNotAllowedException thrown when unsported type is found in the incoming JSON,
154154 * or a property type in your model is not supported by JSONValueTransformer and its categories
@@ -160,7 +160,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
160160 /* *
161161 * If you have an NSArray of data model objects, this method takes it in and outputs a list of the
162162 * matching dictionaries. This method does the opposite of arrayOfObjectsFromDictionaries:
163- * @param a list of JSONModel objects
163+ * @param array list of JSONModel objects
164164 * @return a list of NSDictionary objects
165165 * @exception JSONModelTypeNotAllowedException thrown when unsported type is found in the incoming JSON,
166166 * or a property type in your model is not supported by JSONValueTransformer and its categories
@@ -180,6 +180,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
180180 /* *
181181 * Overriden NSObject method to compare model objects. Compares the <Index> property of the two models,
182182 * if an index property is defined.
183+ * @param object a JSONModel instance to compare to for equality
183184 */
184185 -(BOOL )isEqual:(id )object;
185186
@@ -188,6 +189,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
188189 * If there isn't an index property throws an exception. If the Index property does not have a compare: method
189190 * also throws an exception. NSString and NSNumber have compare: methods, and in case the Index property is
190191 * a another custom class, the programmer should create a custom compare: method then.
192+ * @param object a JSONModel instance to compare to
191193 */
192194 -(NSComparisonResult )compare:(id )object;
193195
@@ -201,6 +203,7 @@ lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
201203 *
202204 * NB: Only setting the error parameter is not enough to fail the validation, you also need to return a NO value.
203205 *
206+ * @param error a pointer to an NSError object, to pass back an error if needed
204207 * @return a BOOL result, showing whether the model data validates or not. You can use the convenience method
205208 * [JSONModelError errorModelIsInvalid] to set the NSError param if the data fails your custom validation
206209 */
0 commit comments