Skip to content
This repository has been archived by the owner on Jan 13, 2022. It is now read-only.

Commit

Permalink
Fix documentation warnings (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
efirestone authored and nscoding committed Dec 5, 2016
1 parent 07d70ea commit ec0906c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions FBSnapshotTestCase/FBSnapshotTestController.h
Expand Up @@ -89,7 +89,7 @@ extern NSString *const FBDiffedImageKey;
@param layer The Layer to snapshot.
@param selector The test method being run.
@param identifier An optional identifier, used is there are muliptle snapshot tests in a given -test method.
@param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@param errorPtr An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@returns YES if the comparison (or saving of the reference image) succeeded.
*/
- (BOOL)compareSnapshotOfLayer:(CALayer *)layer
Expand All @@ -102,7 +102,7 @@ extern NSString *const FBDiffedImageKey;
@param view The view to snapshot.
@param selector The test method being run.
@param identifier An optional identifier, used is there are muliptle snapshot tests in a given -test method.
@param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@param errorPtr An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@returns YES if the comparison (or saving of the reference image) succeeded.
*/
- (BOOL)compareSnapshotOfView:(UIView *)view
Expand All @@ -112,11 +112,11 @@ extern NSString *const FBDiffedImageKey;

/**
Performs the comparison of a view or layer.
@param view The view or layer to snapshot.
@param viewOrLayer The view or layer to snapshot.
@param selector The test method being run.
@param identifier An optional identifier, used is there are muliptle snapshot tests in a given -test method.
@param tolerance The percentage of pixels that can differ and still be considered 'identical'
@param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@param errorPtr An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
@returns YES if the comparison (or saving of the reference image) succeeded.
*/
- (BOOL)compareSnapshotOfViewOrLayer:(id)viewOrLayer
Expand Down

0 comments on commit ec0906c

Please sign in to comment.