More inheritdocs

soundxyz · Jul 30, 2022 · bf75d88 · bf75d88
1 parent b6feb7c
commit bf75d88
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 10 deletions.
diff --git a/contracts/SoundEdition/ISoundEditionV1.sol b/contracts/SoundEdition/ISoundEditionV1.sol
@@ -36,6 +36,13 @@ import "../modules/Metadata/IMetadataModule.sol";
 /// @title ISoundEditionV1
 /// @author Sound.xyz
 interface ISoundEditionV1 is IERC721AUpgradeable, IERC2981Upgradeable {
+    /// @notice Initializes the contract
+    /// @param _owner Owner of contract (artist)
+    /// @param _name Name of the token
+    /// @param _symbol Symbol of the token
+    /// @param _metadataModule Address of metadata module, address(0x00) if not used
+    /// @param baseURI_ Base URI
+    /// @param _contractURI Contract URI for OpenSea storefront
     function initialize(
         address _owner,
         string memory _name,
@@ -54,6 +61,9 @@ interface ISoundEditionV1 is IERC721AUpgradeable, IERC2981Upgradeable {
     /// @param _quantity Number of tokens to mint
     function mint(address _to, uint256 _quantity) external payable;
 
+    /// @notice Informs other contracts which interfaces this contract supports.
+    /// @param interfaceId The interface id to check.
+    /// @dev https://eips.ethereum.org/EIPS/eip-165
     function supportsInterface(bytes4 interfaceId)
         external
         view

diff --git a/contracts/SoundEdition/SoundEditionV1.sol b/contracts/SoundEdition/SoundEditionV1.sol
@@ -66,13 +66,7 @@ contract SoundEditionV1 is ISoundEditionV1, ERC721AQueryableUpgradeable, Ownable
     // PUBLIC & EXTERNAL WRITABLE FUNCTIONS
     // ================================
 
-    /// @notice Initializes the contract
-    /// @param _owner Owner of contract (artist)
-    /// @param _name Name of the token
-    /// @param _symbol Symbol of the token
-    /// @param _metadataModule Address of metadata module, address(0x00) if not used
-    /// @param baseURI_ Base URI
-    /// @param _contractURI Contract URI for OpenSea storefront
+    /// @inheritdoc ISoundEditionV1
     function initialize(
         address _owner,
         string memory _name,
@@ -130,6 +124,7 @@ contract SoundEditionV1 is ISoundEditionV1, ERC721AQueryableUpgradeable, Ownable
     // VIEW FUNCTIONS
     // ================================
 
+    /// @inheritdoc IERC721AUpgradeable
     function tokenURI(uint256 tokenId)
         public
         view
@@ -158,9 +153,7 @@ contract SoundEditionV1 is ISoundEditionV1, ERC721AQueryableUpgradeable, Ownable
             AccessControlUpgradeable.supportsInterface(_interfaceId);
     }
 
-    /// @notice Get royalty information for token
-    /// @param _tokenId token id
-    /// @param _salePrice Sale price for the token
+    /// @inheritdoc IERC2981Upgradeable
     function royaltyInfo(uint256 _tokenId, uint256 _salePrice)
         external
         view