Add comments about mint parameters

PaimaStudios · Apr 2, 2024 · b69d9f1 · b69d9f1
1 parent 297d49c
commit b69d9f1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/contracts/evm-contracts/contracts/token/IInverseBaseProjected1155.sol b/packages/contracts/evm-contracts/contracts/token/IInverseBaseProjected1155.sol
@@ -13,7 +13,10 @@ interface IInverseBaseProjected1155 is IInverseProjected1155 {
     /// Increases the `currentTokenId`.
     /// Reverts if transaction sender is a smart contract that does not implement IERC1155Receiver-onERC1155Received.
     /// Emits the `Minted` event.
-    /// Returns the id of the minted token.
+    /// @param value the amount of tokens to mint.
+    /// @param data additional data to pass to the receiver contract.
+    /// @param initialData data that is emitted in the `Minted` event.
+    /// @return id of the minted token.
     function mint(
         uint256 value,
         bytes memory data,

diff --git a/packages/contracts/evm-contracts/contracts/token/InverseBaseProjected1155.sol b/packages/contracts/evm-contracts/contracts/token/InverseBaseProjected1155.sol
@@ -52,7 +52,10 @@ contract InverseBaseProjected1155 is IInverseBaseProjected1155, ERC1155Supply, O
     /// Increases the `currentTokenId`.
     /// Reverts if transaction sender is a smart contract that does not implement IERC1155Receiver-onERC1155Received.
     /// Emits the `Minted` event.
-    /// Returns the id of the minted token.
+    /// @param value the amount of tokens to mint.
+    /// @param data additional data to pass to the receiver contract.
+    /// @param initialData data that is emitted in the `Minted` event.
+    /// @return id of the minted token.
     function mint(
         uint256 value,
         bytes memory data,