Skip to content
This repository has been archived by the owner on Jun 2, 2018. It is now read-only.

Commit

Permalink
Update documentation for return-nil change.
Browse files Browse the repository at this point in the history
Signed-off-by: Zachary Waldowski <zwaldowski@gmail.com>
  • Loading branch information
zwaldowski committed Feb 26, 2012
1 parent 35dc914 commit cd9e41b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions BlocksKit/NSArray+BlocksKit.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions BlocksKit/NSDictionary+BlocksKit.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions BlocksKit/NSIndexSet+BlocksKit.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions BlocksKit/NSSet+BlocksKit.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion Tests/NSArrayBlocksKitTest.m
Original file line number Diff line number Diff line change
Expand Up @@ -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");
}
Expand Down

0 comments on commit cd9e41b

Please sign in to comment.