NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
github-actions
2023-01-31 00:02:21 +00:00
parent 85a5e4beae
commit 09cdb96c14
8 changed files with 53 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/modules/api/pages/token/ERC1155.adoc
View File

@ -76,6 +76,10 @@
:xref-IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-: xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
:Pausable-_pause: pass:normal[xref:security.adoc#Pausable-_pause--[`Pausable._pause`]]
:Pausable-_unpause: pass:normal[xref:security.adoc#Pausable-_unpause--[`Pausable._unpause`]]
:AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
:Ownable: pass:normal[xref:access.adoc#Ownable[`Ownable`]]
:xref-ERC1155Pausable-_beforeTokenTransfer-address-address-address-uint256---uint256---bytes-: xref:token/ERC1155.adoc#ERC1155Pausable-_beforeTokenTransfer-address-address-address-uint256---uint256---bytes-
:xref-Pausable-paused--: xref:security.adoc#Pausable-paused--
:xref-Pausable-_requireNotPaused--: xref:security.adoc#Pausable-_requireNotPaused--
@ -910,6 +914,12 @@ Useful for scenarios such as preventing trades until the end of an evaluation
period, or having an emergency switch for freezing all token transfers in the
event of a large bug.
IMPORTANT: This contract does not include public pause and unpause functions. In
addition to inheriting this contract, you must define both functions, invoking the
{Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
make the contract unpausable.
_Available since v3.1._
[.contract-index]

10
docs/modules/api/pages/token/ERC20.adoc
View File

@ -122,6 +122,10 @@
:xref-IERC20-Transfer-address-address-uint256-: xref:token/ERC20.adoc#IERC20-Transfer-address-address-uint256-
:xref-IERC20-Approval-address-address-uint256-: xref:token/ERC20.adoc#IERC20-Approval-address-address-uint256-
:ERC20-_mint: pass:normal[xref:token/ERC20.adoc#ERC20-_mint-address-uint256-[`ERC20._mint`]]
:Pausable-_pause: pass:normal[xref:security.adoc#Pausable-_pause--[`Pausable._pause`]]
:Pausable-_unpause: pass:normal[xref:security.adoc#Pausable-_unpause--[`Pausable._unpause`]]
:AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
:Ownable: pass:normal[xref:access.adoc#Ownable[`Ownable`]]
:xref-ERC20Pausable-_beforeTokenTransfer-address-address-uint256-: xref:token/ERC20.adoc#ERC20Pausable-_beforeTokenTransfer-address-address-uint256-
:xref-Pausable-paused--: xref:security.adoc#Pausable-paused--
:xref-Pausable-_requireNotPaused--: xref:security.adoc#Pausable-_requireNotPaused--
@ -1263,6 +1267,12 @@ Useful for scenarios such as preventing trades until the end of an evaluation
period, or having an emergency switch for freezing all token transfers in the
event of a large bug.
IMPORTANT: This contract does not include public pause and unpause functions. In
addition to inheriting this contract, you must define both functions, invoking the
{Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
make the contract unpausable.
[.contract-index]
.Functions
--

10
docs/modules/api/pages/token/ERC721.adoc
View File

@ -155,6 +155,10 @@
:xref-IERC721Receiver-onERC721Received-address-address-uint256-bytes-: xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-
:IERC721: pass:normal[xref:token/ERC721.adoc#IERC721[`IERC721`]]
:IERC721-safeTransferFrom: pass:normal[xref:token/ERC721.adoc#IERC721-safeTransferFrom-address-address-uint256-[`IERC721.safeTransferFrom`]]
:Pausable-_pause: pass:normal[xref:security.adoc#Pausable-_pause--[`Pausable._pause`]]
:Pausable-_unpause: pass:normal[xref:security.adoc#Pausable-_unpause--[`Pausable._unpause`]]
:AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
:Ownable: pass:normal[xref:access.adoc#Ownable[`Ownable`]]
:xref-ERC721Pausable-_beforeTokenTransfer-address-address-uint256-uint256-: xref:token/ERC721.adoc#ERC721Pausable-_beforeTokenTransfer-address-address-uint256-uint256-
:xref-Pausable-paused--: xref:security.adoc#Pausable-paused--
:xref-Pausable-_requireNotPaused--: xref:security.adoc#Pausable-_requireNotPaused--
@ -1409,6 +1413,12 @@ Useful for scenarios such as preventing trades until the end of an evaluation
period, or having an emergency switch for freezing all token transfers in the
event of a large bug.
IMPORTANT: This contract does not include public pause and unpause functions. In
addition to inheriting this contract, you must define both functions, invoking the
{Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
make the contract unpausable.
[.contract-index]
.Functions
--