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
2025-01-22 04:00:10 +00:00
parent edf6031131
commit 0dda004024
124 changed files with 8439 additions and 1170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/modules/api/pages/access.adoc
View File

@ -358,7 +358,7 @@ This directory provides ways to restrict who can access the functions of a contr
[.contract]
[[Ownable]]
=== `++Ownable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/Ownable.sol[{github-icon},role=heading-link]
=== `++Ownable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/Ownable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -481,7 +481,7 @@ The owner is not a valid owner account. (eg. `address(0)`)
[.contract]
[[Ownable2Step]]
=== `++Ownable2Step++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/Ownable2Step.sol[{github-icon},role=heading-link]
=== `++Ownable2Step++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/Ownable2Step.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -587,7 +587,7 @@ The new owner accepts the ownership transfer.
[.contract]
[[IAccessControl]]
=== `++IAccessControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/IAccessControl.sol[{github-icon},role=heading-link]
=== `++IAccessControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/IAccessControl.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -740,7 +740,7 @@ NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
[.contract]
[[AccessControl]]
=== `++AccessControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/AccessControl.sol[{github-icon},role=heading-link]
=== `++AccessControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/AccessControl.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -982,7 +982,7 @@ May emit a {RoleRevoked} event.
[.contract]
[[IAccessControlEnumerable]]
=== `++IAccessControlEnumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/extensions/IAccessControlEnumerable.sol[{github-icon},role=heading-link]
=== `++IAccessControlEnumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/extensions/IAccessControlEnumerable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1061,7 +1061,7 @@ together with {getRoleMember} to enumerate all bearers of a role.
[.contract]
[[AccessControlEnumerable]]
=== `++AccessControlEnumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/extensions/AccessControlEnumerable.sol[{github-icon},role=heading-link]
=== `++AccessControlEnumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/extensions/AccessControlEnumerable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1224,7 +1224,7 @@ Overload {AccessControl-_revokeRole} to track enumerable memberships
[.contract]
[[IAccessControlDefaultAdminRules]]
=== `++IAccessControlDefaultAdminRules++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/extensions/IAccessControlDefaultAdminRules.sol[{github-icon},role=heading-link]
=== `++IAccessControlDefaultAdminRules++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/extensions/IAccessControlDefaultAdminRules.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1513,7 +1513,7 @@ NOTE: `schedule` can be 0 indicating there's no transfer scheduled.
[.contract]
[[AccessControlDefaultAdminRules]]
=== `++AccessControlDefaultAdminRules++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/extensions/AccessControlDefaultAdminRules.sol[{github-icon},role=heading-link]
=== `++AccessControlDefaultAdminRules++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/extensions/AccessControlDefaultAdminRules.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1934,7 +1934,7 @@ See {defaultAdminDelayIncreaseWait}.
[.contract]
[[IAuthority]]
=== `++IAuthority++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/IAuthority.sol[{github-icon},role=heading-link]
=== `++IAuthority++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/IAuthority.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2011,7 +2011,7 @@ Returns true if the caller can invoke on a target the function identified by a f
[.contract]
[[IAccessManager]]
=== `++IAccessManager++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/IAccessManager.sol[{github-icon},role=heading-link]
=== `++IAccessManager++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/IAccessManager.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2585,7 +2585,7 @@ Admin delay for a given `target` will be updated to `delay` when `since` is reac
[.contract]
[[AccessManager]]
=== `++AccessManager++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/AccessManager.sol[{github-icon},role=heading-link]
=== `++AccessManager++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/AccessManager.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3186,7 +3186,7 @@ The identifier of the public role. Automatically granted to all addresses with n
[.contract]
[[IAccessManaged]]
=== `++IAccessManaged++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/IAccessManaged.sol[{github-icon},role=heading-link]
=== `++IAccessManaged++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/IAccessManaged.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3266,7 +3266,7 @@ Authority that manages this contract was updated.
[.contract]
[[AccessManaged]]
=== `++AccessManaged++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/AccessManaged.sol[{github-icon},role=heading-link]
=== `++AccessManaged++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/AccessManaged.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3394,7 +3394,7 @@ is less than 4 bytes long.
[.contract]
[[AuthorityUtils]]
=== `++AuthorityUtils++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/access/manager/AuthorityUtils.sol[{github-icon},role=heading-link]
=== `++AuthorityUtils++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/access/manager/AuthorityUtils.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity