Skip to content

Commit

Permalink
fix : updated incomplete docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Rishabh Sharma committed Sep 7, 2023
1 parent d2c1701 commit 7281bcb
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

0 comments on commit 7281bcb

Please sign in to comment.