Hardhat compile error with @openzeppelin/hardhat-upgrades

[hegelwin]

I'm developing a project that uses prb-math library. I can't compile the project after I enable hardhat-upgrades v3.2.0:

> v0@1.0.0 compile
> hardhat compile

An unexpected error occurred:

Error: Failed to compile modified contracts for namespaced storage:

DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/ud60x18/Math.sol:50:1:
   |
50 | /// @notice Yields the smallest whole number greater than or equal to x.
   | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/ud60x18/Math.sol:63:1:
   |
63 | /// @notice Divides two UD60x18 numbers, returning a new UD60x18 number.
   | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
   --> @prb/math/src/ud60x18/Math.sol:106:1:
    |
106 | /// @notice Yields the greatest whole number less than or equal to x.
    | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
   --> @prb/math/src/ud60x18/Math.sol:114:1:
    |
114 | /// @notice Yields the excess beyond the floor of x using the odd function definition.
    | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/sd59x18/Math.sol:26:1:
   |
26 | /// @notice Calculates the absolute value of x.
   | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/sd59x18/Math.sol:47:1:
   |
47 | /// @notice Yields the smallest whole number greater than or equal to x.
   | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/sd59x18/Math.sol:60:1:
   |
60 | /// @notice Divides two SD59x18 numbers, returning a new SD59x18 number.
   | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
   --> @prb/math/src/sd59x18/Math.sol:119:1:
    |
119 | /// @notice Yields the greatest whole number less than or equal to x.
    | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
   --> @prb/math/src/sd59x18/Math.sol:132:1:
    |
132 | /// @notice Yields the excess beyond the floor of x for positive numbers and the part of the number to the right.
    | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
 --> @prb/math/src/sd59x18/Conversions.sol:8:1:
  |
8 | /// @notice Converts a simple integer to SD59x18 by multiplying it by `UNIT`.
  | ^ (Relevant source part starts here and spans across multiple lines).


DocstringParsingError: Documented parameter "result" not found in the parameter list of the function.
  --> @prb/math/src/ud60x18/Conversions.sol:14:1:
   |
14 | /// @notice Converts a simple integer to UD60x18 by multiplying it by `UNIT`.
   | ^ (Relevant source part starts here and spans across multiple lines).

It looks like this problem has already been discussed before, but is still not completely fixed.

How can I disable this check to compile the project?

[ericglau]

Thanks for reporting. This is fixed in @openzeppelin/upgrades-core@1.34.4 which is used by @openzeppelin/hardhat-upgrades.

You can get the fix by updating your dependencies, for example npm install @openzeppelin/upgrades-core@latest