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-05-23 18:18:00 +00:00
parent 6ae39c4dc1
commit cf52c4a0a5
158 changed files with 331 additions and 470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -924,7 +924,7 @@ NOTE: Functions of the `Governor` contract do not include access control. If you
[.contract]
[[IGovernor]]
=== `++IGovernor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/IGovernor.sol[{github-icon},role=heading-link]
=== `++IGovernor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/IGovernor.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1268,7 +1268,7 @@ Note: `support` values should be seen as buckets. Their interpretation depends o
[.contract]
[[Governor]]
=== `++Governor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/Governor.sol[{github-icon},role=heading-link]
=== `++Governor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/Governor.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1680,7 +1680,7 @@ See {IERC1155Receiver-onERC1155BatchReceived}.
[.contract]
[[GovernorCountingSimple]]
=== `++GovernorCountingSimple++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorCountingSimple.sol[{github-icon},role=heading-link]
=== `++GovernorCountingSimple++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorCountingSimple.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1854,7 +1854,7 @@ See {Governor-_countVote}. In this module, the support follows the `VoteType` en
[.contract]
[[GovernorVotes]]
=== `++GovernorVotes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorVotes.sol[{github-icon},role=heading-link]
=== `++GovernorVotes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorVotes.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2016,7 +2016,7 @@ Machine-readable description of the clock as specified in EIP-6372.
[.contract]
[[GovernorVotesQuorumFraction]]
=== `++GovernorVotesQuorumFraction++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorVotesQuorumFraction.sol[{github-icon},role=heading-link]
=== `++GovernorVotesQuorumFraction++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorVotesQuorumFraction.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2230,7 +2230,7 @@ Requirements:
[.contract]
[[GovernorVotesComp]]
=== `++GovernorVotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorVotesComp.sol[{github-icon},role=heading-link]
=== `++GovernorVotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorVotesComp.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2397,7 +2397,7 @@ Machine-readable description of the clock as specified in EIP-6372.
[.contract]
[[GovernorTimelockControl]]
=== `++GovernorTimelockControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorTimelockControl.sol[{github-icon},role=heading-link]
=== `++GovernorTimelockControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorTimelockControl.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2635,7 +2635,7 @@ Emitted when the timelock controller used for proposal execution is modified.
[.contract]
[[GovernorTimelockCompound]]
=== `++GovernorTimelockCompound++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorTimelockCompound.sol[{github-icon},role=heading-link]
=== `++GovernorTimelockCompound++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorTimelockCompound.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2884,7 +2884,7 @@ Emitted when the timelock controller used for proposal execution is modified.
[.contract]
[[GovernorSettings]]
=== `++GovernorSettings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorSettings.sol[{github-icon},role=heading-link]
=== `++GovernorSettings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorSettings.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3118,7 +3118,7 @@ Emits a {ProposalThresholdSet} event.
[.contract]
[[GovernorPreventLateQuorum]]
=== `++GovernorPreventLateQuorum++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorPreventLateQuorum.sol[{github-icon},role=heading-link]
=== `++GovernorPreventLateQuorum++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorPreventLateQuorum.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3340,7 +3340,7 @@ Emitted when the {lateQuorumVoteExtension} parameter is changed.
[.contract]
[[GovernorCompatibilityBravo]]
=== `++GovernorCompatibilityBravo++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/compatibility/GovernorCompatibilityBravo.sol[{github-icon},role=heading-link]
=== `++GovernorCompatibilityBravo++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/compatibility/GovernorCompatibilityBravo.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3613,7 +3613,7 @@ See {Governor-_countVote}. In this module, the support follows Governor Bravo.
[.contract]
[[GovernorProposalThreshold]]
=== `++GovernorProposalThreshold++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/extensions/GovernorProposalThreshold.sol[{github-icon},role=heading-link]
=== `++GovernorProposalThreshold++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/extensions/GovernorProposalThreshold.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3769,7 +3769,7 @@ See {IGovernor-propose}.
[.contract]
[[Votes]]
=== `++Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/utils/Votes.sol[{github-icon},role=heading-link]
=== `++Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/utils/Votes.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4007,7 +4007,7 @@ In a governance system, the {TimelockController} contract is in charge of introd
[.contract]
[[TimelockController]]
=== `++TimelockController++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/governance/TimelockController.sol[{github-icon},role=heading-link]
=== `++TimelockController++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/governance/TimelockController.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity