Wdocumentation error during grpc ios compile #590

New issue

Closed

opened 2021-10-15 13:03:34 -05:00 by HannahShiSFB · 3 comments

HannahShiSFB commented

2021-10-15 13:03:34 -05:00

(Migrated from github.com)

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.

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.

👍 1

Cyan4973 commented

2021-11-25 13:23:01 -06:00

(Migrated from github.com)

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.

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 commented

2021-11-25 17:08:40 -06:00

(Migrated from github.com)

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, ...

``` 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, ... ```

👍 1

Cyan4973 commented

2021-11-25 17:36:43 -06:00

(Migrated from github.com)

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

👍 1

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-Cyan4973/xxHash#590

No description provided.

Rows
Columns