8000 Fix: Corrected typos in NatSpec doc blocks by rickymcalister · Pull Request #258 · immutable/contracts · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix: Corrected typos in NatSpec doc blocks #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on 8000 GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix: Corrected typos in NatSpec doc blocks #258

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f928c3
Correct @param mintRequest reference to reflect the list of mint requ…
rickymcalister Jan 11, 2025
92adb78
Consistency: Remove preceeding white space from natspec doc tags
rickymcalister Jan 11, 2025
9e1d5c8
Typo: Correct typo in setNFTRoyaltyReceiver and setNFTRoyaltyReceiver…
rickymcalister Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions contracts/token/erc721/abstract/ImmutableERC721Base.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice Set the royalty receiver address for a specific tokenId
* @param tokenId the token to set the royalty for
* @param receiver the address to receive the royalty
* @param feeNumerator the royalty fee numerator
* @dev This can only be called by the a minter. See ERC2981 for more details on _setTokenRoyalty
* @param tokenId the token to set the royalty for
* @param receiver the address to receive the royalty
* @param feeNumerator the royalty fee numerator
* @dev This can only be called by a minter. See ERC2981 for more details on _setTokenRoyalty
*/
function setNFTRoyaltyReceiver(
uint256 tokenId,
Expand All @@ -113,10 +113,10 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice Set the royalty receiver address for a list of tokenId
* @param tokenIds the list of tokens to set the royalty for
* @param receiver the address to receive the royalty
* @param feeNumerator the royalty fee numerator
* @dev This can only be called by the a minter. See ERC2981 for more details on _setTokenRoyalty
* @param tokenIds the list of tokens to set the royalty for
* @param receiver the address to receive the royalty
* @param feeNumerator the royalty fee numerator
* @dev This can only be called by a minter. See ERC2981 for more details on _setTokenRoyalty
*/
function setNFTRoyaltyReceiverBatch(
uint256[] calldata tokenIds,
Expand All @@ -130,8 +130,8 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice allows owner or operator to burn a single token
* @param tokenId the token to burn
* @dev see ERC721Burnable for more details
* @param tokenId the token to burn
* @dev see ERC721Burnable for more details
*/
function burn(uint256 tokenId) public override(ERC721Burnable) {
super.burn(tokenId);
Expand All @@ -142,8 +142,8 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice Burn a token, checking the owner of the token against the parameter first.
* @param owner the owner of the token
* @param tokenId the token to burn
* @param owner the owner of the token
* @param tokenId the token to burn
*/
function safeBurn(address owner, uint256 tokenId) public virtual {
address currentOwner = ownerOf(tokenId);
Expand All @@ -156,7 +156,7 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice Burn a batch of tokens, checking the owner of the token against the parameter first.
* @param burns list of burn requests including token id and owner address
* @param burns list of burn requests including token id and owner address
*/
function _safeBurnBatch(IDBurn[] calldata burns) public virtual {
for (uint256 i = 0; i < burns.length; i++) {
Expand Down Expand Up @@ -193,7 +193,7 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice Returns the supported interfaces
* @param interfaceId the interface to check for support
* @param interfaceId the interface to check for support
*/
function supportsInterface(
bytes4 interfaceId
Expand Down Expand Up @@ -232,8 +232,8 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice mints a batch of tokens with specified ids to a specified address
* @param mintRequest list of mint requests including token id and owner address
* @dev see ERC721 for more details on _mint
* @param mintRequest list of mint requests including token id and owner address
* @dev see ERC721 for more details on _mint
*/
function _batchMint(IDMint calldata mintRequest) internal {
if (mintRequest.to == address(0)) {
Expand All @@ -249,8 +249,8 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice safe mints a batch of tokens with specified ids to a specified address
* @param mintRequest list of burn requests including token id and owner address
* @dev see ERC721 for more details on _safeMint
* @param mintRequest list of mint requests including token id and owner address
* @dev see ERC721 for more details on _safeMint
*/
function _safeBatchMint(IDMint calldata mintRequest) internal {
if (mintRequest.to == address(0)) {
Expand All @@ -265,9 +265,9 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice mints specified token id to specified address
* @param to the address to mint to
* @param tokenId the token to mint
* @dev see ERC721 for more details on _mint
* @param to the address to mint to
* @param tokenId the token to mint
* @dev see ERC721 for more details on _mint
*/
function _mint(address to, uint256 tokenId) internal override(ERC721) {
if (_burnedTokens.get(tokenId)) {
Expand All @@ -278,9 +278,9 @@ abstract contract ImmutableERC721Base is OperatorAllowlistEnforced, MintingAcces

/**
* @notice safe mints specified token id to specified address
* @param to the address to mint to
* @param tokenId the token to mint
* @dev see ERC721 for more details on _safeMint
* @param to the address to mint to
* @param tokenId the token to mint
* @dev see ERC721 for more details on _safeMint
*/
function _safeMint(address to, uint256 tokenId) internal override(ERC721) {
if (_burnedTokens.get(tokenId)) {
Expand Down
0