Permalink
Browse files

Update documentation for return-nil change.

Signed-off-by: Zachary Waldowski <zwaldowski@gmail.com>
  • Loading branch information...
1 parent 35dc914 commit cd9e41bb566c4cba86a14112b99a801c8f77610c @zwaldowski zwaldowski committed Feb 26, 2012
@@ -50,15 +50,15 @@
on the first match.
@param block A single-argument, `BOOL`-returning code block.
- @return Returns the object if found, `nil` otherwise.
+ @return Returns the object, if found, or `nil`.
@see select:
*/
- (id)match:(BKValidationBlock)block;
/** Loops through an array to find the objects matching the block.
@param block A single-argument, BOOL-returning code block.
- @return Returns an array of the objects found, `nil` otherwise.
+ @return Returns an array of the objects found.
@see match:
*/
- (NSArray *)select:(BKValidationBlock)block;
@@ -73,7 +73,7 @@
}];
@param block A single-argument, BOOL-returning code block.
- @return Returns an array of all objects not found, `nil` if all are excluded.
+ @return Returns an array of all objects not found.
*/
- (NSArray *)reject:(BKValidationBlock)block;
@@ -43,7 +43,7 @@
/** Loops through a dictionary to find the key/value pairs matching the block.
@param block A BOOL-returning code block for a key/value pair.
- @return Returns a dictionary of the objects found, `nil` otherwise.
+ @return Returns a dictionary of the objects found.
*/
- (NSDictionary *)select:(BKKeyValueValidationBlock)block;
@@ -57,7 +57,7 @@
}];
@param block A BOOL-returning code block for a key/value pair.
- @return Returns a dictionary of all objects not found, `nil` if all are excluded.
+ @return Returns a dictionary of all objects not found.
*/
- (NSDictionary *)reject:(BKKeyValueValidationBlock)block;
@@ -52,7 +52,7 @@
/** Loops through an index set and returns an all indexes matching the block.
@param block A single-argument, BOOL-returning code block.
- @return Returns an index set of matching indexes found, `nil` otherwise.
+ @return Returns an index set of matching indexes found.
@see match:
*/
- (NSIndexSet *)select:(BKIndexValidationBlock)block;
@@ -62,7 +62,7 @@
This selector performs *literally* the exact same function as select: but in reverse.
@param block A single-argument, BOOL-returning code block.
- @return Returns an index set of all indexes but those matched, `nil` if all are excluded.
+ @return Returns an index set of all indexes but those matched.
*/
- (NSIndexSet *)reject:(BKIndexValidationBlock)block;
@@ -56,7 +56,7 @@
/** Loops through a set to find the objects matching the block.
@param block A single-argument, BOOL-returning code block.
- @return Returns a set of the objects found, `nil` otherwise.
+ @return Returns a set of the objects found.
@see match:
*/
- (NSSet *)select:(BKValidationBlock)block;
@@ -71,7 +71,7 @@
}];
@param block A single-argument, BOOL-returning code block.
- @return Returns an array of all objects not found, `nil` if all are excluded.
+ @return Returns an array of all objects not found.
*/
- (NSSet *)reject:(BKValidationBlock)block;
@@ -51,7 +51,7 @@ - (void)testNotMatch {
};
id found = [_subject match:validationBlock];
- //@return Returns the object if found, `nil` otherwise.
+ // @return Returns the object if found, `nil` otherwise.
GHAssertEquals(_total,6,@"total length of \"122333\" is %d",_total);
GHAssertNil(found,@"no matched object");
}

0 comments on commit cd9e41b

Please sign in to comment.