Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build errors about documentation headers when building Tests #1400

Closed
bolsinga opened this issue Mar 12, 2019 · 2 comments
Closed

Build errors about documentation headers when building Tests #1400

bolsinga opened this issue Mar 12, 2019 · 2 comments

Comments

@bolsinga
Copy link
Contributor

Here is the error:

In file included from /Users/gbolsinga/code/Texture/Tests/ASCenterLayoutSpecSnapshotTests.mm:10:
In file included from /Users/gbolsinga/code/Texture/Tests/ASLayoutSpecSnapshotTestsHelper.h:10:
In file included from /Users/gbolsinga/code/Texture/Tests/ASSnapshotTestCase.h:10:
In file included from /Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestCase.h:12:
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:92:9: error: parameter 'error' not found in the function declaration [-Werror,-Wdocumentation]
 @param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
        ^~~~~
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:92:9: note: did you mean 'errorPtr'?
 @param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
        ^~~~~
        errorPtr
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:105:9: error: parameter 'error' not found in the function declaration [-Werror,-Wdocumentation]
 @param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
        ^~~~~
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:105:9: note: did you mean 'errorPtr'?
 @param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
        ^~~~~
        errorPtr
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:115:9: error: parameter 'view' not found in the function declaration [-Werror,-Wdocumentation]
 @param view The view or layer to snapshot.
        ^~~~
/Users/gbolsinga/code/Texture/Pods/Headers/Public/FBSnapshotTestCase/FBSnapshotTestController.h:119:9: error: parameter 'error' not found in the function declaration [-Werror,-Wdocumentation]
 @param error An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ, etc).
        ^~~~~
4 errors generated.

This is fixed in the latest FBSnapshotTestCase, but it has changed ownership, bumped versions and moved past the versions supported by Texture. I think we can disable this warning locally in ASSnapshotTestCase.

@bolsinga
Copy link
Contributor Author

Fixed by uber/ios-snapshot-test-case@ec0906c in FBSnapshotTestCase.

@bolsinga bolsinga changed the title Build error when building Tests Build errors about documentation headers when building Tests Mar 12, 2019
@bolsinga
Copy link
Contributor Author

It occurs in a few places, including when JGMethodSwizzler is used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant