Fix uri() NatSpec

valorem-labs-inc · Dec 16, 2022 · fc35a41 · fc35a41
1 parent 74fb506
commit fc35a41
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/OptionSettlementEngine.sol b/src/OptionSettlementEngine.sol
@@ -295,7 +295,9 @@ contract OptionSettlementEngine is ERC1155, IOptionSettlementEngine {
         }
     }
 
-    /// @returns the URI for a given tokenId.
+    /// @notice Returns the URI for a given tokenId.
+    /// @param tokenId The tokenId of an option or claim.
+    /// @return The URI for the tokenId.
     function uri(uint256 tokenId) public view virtual override returns (string memory) {
         Option memory optionInfo = optionTypeStates[uint160(tokenId >> OPTION_KEY_PADDING)].option;