From 7281bcbb1b22c18377e57b1aa3958806b4614f9b Mon Sep 17 00:00:00 2001 From: Rishabh Sharma Date: Tue, 29 Aug 2023 19:59:48 +0530 Subject: [PATCH] fix : updated incomplete docstrings --- .../contracts/MultiRoyaltyDistributor.sol | 7 ++++--- .../contracts/RoyaltyManager.sol | 2 ++ .../contracts/interfaces/IMultiRoyaltyDistributor.sol | 8 ++++++-- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/packages/dependency-royalty-management/contracts/MultiRoyaltyDistributor.sol b/packages/dependency-royalty-management/contracts/MultiRoyaltyDistributor.sol index 600539931f..b4363aecf0 100644 --- a/packages/dependency-royalty-management/contracts/MultiRoyaltyDistributor.sol +++ b/packages/dependency-royalty-management/contracts/MultiRoyaltyDistributor.sol @@ -26,9 +26,9 @@ abstract contract MultiRoyaltyDistributor is IEIP2981, IMultiRoyaltyDistributor, _setRoyaltyManager(_royaltyManager); } - /// @notice EIP 165 interface function - /// @dev used to check the interface implemented - /// @param interfaceId to be checked for implementation + /// @notice Query if a contract implements interface `id`. + /// @param interfaceId the interface identifier, as specified in ERC-165. + /// @return `true` if the contract implements `id`. function supportsInterface(bytes4 interfaceId) public view @@ -46,6 +46,7 @@ abstract contract MultiRoyaltyDistributor is IEIP2981, IMultiRoyaltyDistributor, /// @notice sets token royalty /// @dev deploys a splitter if a creator doesn't have one /// @param tokenId id of token + /// @param recipient royalty recipient /// @param creator of the token function _setTokenRoyalties( uint256 tokenId, diff --git a/packages/dependency-royalty-management/contracts/RoyaltyManager.sol b/packages/dependency-royalty-management/contracts/RoyaltyManager.sol index 8adae7cf0d..25a24eebfc 100644 --- a/packages/dependency-royalty-management/contracts/RoyaltyManager.sol +++ b/packages/dependency-royalty-management/contracts/RoyaltyManager.sol @@ -89,6 +89,7 @@ contract RoyaltyManager is AccessControlUpgradeable, IRoyaltyManager { } /// @notice get the current trustedForwarder address + /// @return address of current TrustedForwarder function getTrustedForwarder() public view returns (address) { return _trustedForwarder; } @@ -115,6 +116,7 @@ contract RoyaltyManager is AccessControlUpgradeable, IRoyaltyManager { /// @notice called to set the EIP 2981 royalty split /// @dev can only be called by contract royalty setter. + /// @param contractAddress address of contract for which royalty is set /// @param _royaltyBps the royalty split for the EIP 2981 function setContractRoyalty(address contractAddress, uint16 _royaltyBps) external diff --git a/packages/dependency-royalty-management/contracts/interfaces/IMultiRoyaltyDistributor.sol b/packages/dependency-royalty-management/contracts/interfaces/IMultiRoyaltyDistributor.sol index 3420465313..97b7a8930f 100644 --- a/packages/dependency-royalty-management/contracts/interfaces/IMultiRoyaltyDistributor.sol +++ b/packages/dependency-royalty-management/contracts/interfaces/IMultiRoyaltyDistributor.sol @@ -24,13 +24,17 @@ interface IMultiRoyaltyDistributor is IERC165, IMultiRoyaltyRecipients { Recipient[] recipients; } - ///@dev Set per token royalties. Passing a recipient of address(0) will delete any existing configuration + ///@notice Set per token royalties. Passing a recipient of address(0) will delete any existing configuration + ///@param tokenId The ID of the token for which to set the royalties. + ///@param recipient The address that will receive the royalties. + ///@param creator The creator's address for the token. function setTokenRoyalties( uint256 tokenId, address payable recipient, address creator ) external; - ///@dev Helper function to get all splits contracts + ///@notice Helper function to get all splits contracts + ///@return an array of royalty receiver function getAllSplits() external view returns (address payable[] memory); }