Skip to content

Commit b7d65db

Browse files
authored
Merge pull request #365 from 1inch/audit/oz-l-02
[SC-1465] Add Incomplete Docstrings
2 parents ed58e0e + 52551dc commit b7d65db

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

contracts/interfaces/IAmountGetter.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ interface IAmountGetter {
1818
* @param takingAmount Actual taking amount
1919
* @param remainingMakingAmount Order remaining making amount
2020
* @param extraData Extra data
21+
* @return makingAmount Actual making amount that should be used for the order
2122
*/
2223
function getMakingAmount(
2324
IOrderMixin.Order calldata order,
@@ -38,6 +39,7 @@ interface IAmountGetter {
3839
* @param makingAmount Actual taking amount
3940
* @param remainingMakingAmount Order remaining making amount
4041
* @param extraData Extra data
42+
* @return takingAmount Actual taking amount that should be used for the order
4143
*/
4244
function getTakingAmount(
4345
IOrderMixin.Order calldata order,

contracts/interfaces/IOrderMixin.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,15 @@ interface IOrderMixin {
8282

8383
/**
8484
* @notice Returns bitmask for double-spend invalidators based on lowest byte of order.info and filled quotes
85+
* @param maker Address of the order maker
8586
* @param orderHash Hash of the order
8687
* @return remaining Remaining amount of the order
8788
*/
8889
function remainingInvalidatorForOrder(address maker, bytes32 orderHash) external view returns(uint256 remaining);
8990

9091
/**
9192
* @notice Returns bitmask for double-spend invalidators based on lowest byte of order.info and filled quotes
93+
* @param maker Address of the order maker
9294
* @param orderHash Hash of the order
9395
* @return remainingRaw Inverse of the remaining amount of the order if order was filled at least once, otherwise 0
9496
*/

0 commit comments

Comments
 (0)