refactor: added Natspec

thesandboxgame · Oct 9, 2023 · 3b475fb · 3b475fb
1 parent 847904a
commit 3b475fb
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/packages/marketplace/contracts/mocks/Royalties2981TestImpl.sol b/packages/marketplace/contracts/mocks/Royalties2981TestImpl.sol
@@ -6,6 +6,8 @@ import {IERC2981} from "@openzeppelin/contracts/interfaces/IERC2981.sol";
 import {LibRoyalties2981} from "../royalties/LibRoyalties2981.sol";
 import {LibPart} from "../lib-part/LibPart.sol";
 
+/// @title Royalties2981TestImpl Contract
+/// @dev serves as an implementation of the IERC2981
 contract Royalties2981TestImpl is IERC2981 {
     uint256 public royaltiesBasePoint;
 

diff --git a/packages/marketplace/contracts/mocks/TestERC1271.sol b/packages/marketplace/contracts/mocks/TestERC1271.sol
@@ -4,6 +4,8 @@ pragma solidity 0.8.21;
 
 import {IERC1271Upgradeable} from "@openzeppelin/contracts-upgradeable/interfaces/IERC1271Upgradeable.sol";
 
+/// @title TestERC1271 Contract
+/// @dev implements the ERC1271 standard for signature validation
 contract TestERC1271 is IERC1271Upgradeable {
     bool private returnSuccessfulValidSignature;
 

diff --git a/packages/marketplace/contracts/mocks/TestERC721WithRoyaltyWithoutIROYALTYUGC.sol b/packages/marketplace/contracts/mocks/TestERC721WithRoyaltyWithoutIROYALTYUGC.sol
@@ -8,7 +8,7 @@ import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Own
 import {LibRoyalties2981} from "../royalties/LibRoyalties2981.sol";
 import {Royalties2981TestImpl} from "./Royalties2981TestImpl.sol";
 
-/// @title TestERC721WithRoyaltyWithoutIROYALTYUGC contract
+/// @title TestERC721WithRoyaltyWithoutIROYALTYUGC Contract
 /// @dev Contract that do not supports INTERFACE_ID_IROYALTYUGC.
 /// @dev used to set royalty greater than 50%
 contract TestERC721WithRoyaltyWithoutIROYALTYUGC is