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

Wdocumentation error during grpc ios compile #590

Closed
HannahShiSFB opened this issue Oct 15, 2021 · 3 comments · Fixed by #601
Closed

Wdocumentation error during grpc ios compile #590

HannahShiSFB opened this issue Oct 15, 2021 · 3 comments · Fixed by #601

Comments

@HannahShiSFB
Copy link

the logs are as follow:

../../../../../../third_party/xxhash/xxhash.h:1916:11: error: parameter 'input,' not found in the function declaration [-Werror,-Wdocumentation]

  • @param input, len, seed Directly passed from @ref XXH32().
    ^~~~~~
    ../../../../../../third_party/xxhash/xxhash.h:1916:11: note: did you mean 'input'?
  • @param input, len, seed Directly passed from @ref XXH32().
    ^~~~~~
    input
    ../../../../../../third_party/xxhash/xxhash.h:3104:11: error: parameter 'lhs,' not found in the function declaration [-Werror,-Wdocumentation]
  • @param lhs, rhs The 64-bit integers to be multiplied
    ^~~~
    ../../../../../../third_party/xxhash/xxhash.h:3104:11: note: did you mean 'lhs'?
  • @param lhs, rhs The 64-bit integers to be multiplied
    ^~~~
    lhs
    ../../../../../../third_party/xxhash/xxhash.h:3222:11: error: parameter 'lhs,' not found in the function declaration [-Werror,-Wdocumentation]
  • @param lhs, rhs The 64-bit integers to multiply
    ^~~~
    ../../../../../../third_party/xxhash/xxhash.h:3222:11: note: did you mean 'lhs'?
  • @param lhs, rhs The 64-bit integers to multiply
    ^~~~
    lhs
    3 errors generated.
@Cyan4973
Copy link
Owner

cc @easyaspi314 .

I see the -Wdocumentation compiler warning,
but I'm not sure what to do.
It seems to complain that some parameter is not found in the function declaration,
but the parameter is definitely present.

@t-mat
Copy link
Contributor

t-mat commented Nov 25, 2021

xxhash.h:1916:11: error: parameter 'input,' not found in the function declaration [-Werror,-Wdocumentation]

It seems extra , causes this error. After the argument name, we should place explicit space/tab to avoid this error. For example

- * @param input, len, ...
+ * @param input , len, ...

@Cyan4973
Copy link
Owner

Thanks @t-mat ! This seems to fix it perfectly !

Cyan4973 added a commit that referenced this issue Nov 25, 2021
fix #590,
thanks to @t-mat for providing the solution !
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants