From 85a5e4beae6d48550abd17fd05f12fe3a08a18bd Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 16 Jan 2023 19:07:02 +0000
Subject: [PATCH] Update docs

---
 docs/modules/api/pages/access.adoc        | 10 +++++-----
 docs/modules/api/pages/finance.adoc       |  4 ++--
 docs/modules/api/pages/governance.adoc    | 12 ++++++------
 docs/modules/api/pages/interfaces.adoc    |  4 ++--
 docs/modules/api/pages/proxy.adoc         |  6 +++---
 docs/modules/api/pages/token/ERC1155.adoc |  8 ++++----
 docs/modules/api/pages/token/ERC20.adoc   |  4 ++--
 docs/modules/api/pages/token/ERC721.adoc  |  6 +++---
 docs/modules/api/pages/token/ERC777.adoc  | 10 +++++-----
 docs/modules/api/pages/utils.adoc         |  8 ++++----
 docs/templates/helpers.js                 |  2 +-
 11 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/docs/modules/api/pages/access.adoc b/docs/modules/api/pages/access.adoc
index 5d090f4c8..03b35cc72 100644
--- a/docs/modules/api/pages/access.adoc
+++ b/docs/modules/api/pages/access.adoc
@@ -213,7 +213,7 @@ Internal function without access restriction.
 
 [.contract-item]
 [[Ownable-OwnershipTransferred-address-address-]]
-==== `[.contract-item-name]#++OwnershipTransferred++#++(address previousOwner, address newOwner)++` [.item-kind]#event#
+==== `[.contract-item-name]#++OwnershipTransferred++#++(address indexed previousOwner, address indexed newOwner)++` [.item-kind]#event#
 
 :_pendingOwner: pass:normal[xref:#Ownable2Step-_pendingOwner-address[`++_pendingOwner++`]]
 :OwnershipTransferStarted: pass:normal[xref:#Ownable2Step-OwnershipTransferStarted-address-address-[`++OwnershipTransferStarted++`]]
@@ -296,7 +296,7 @@ The new owner accepts the ownership transfer.
 
 [.contract-item]
 [[Ownable2Step-OwnershipTransferStarted-address-address-]]
-==== `[.contract-item-name]#++OwnershipTransferStarted++#++(address previousOwner, address newOwner)++` [.item-kind]#event#
+==== `[.contract-item-name]#++OwnershipTransferStarted++#++(address indexed previousOwner, address indexed newOwner)++` [.item-kind]#event#
 
 :RoleAdminChanged: pass:normal[xref:#IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-[`++RoleAdminChanged++`]]
 :RoleGranted: pass:normal[xref:#IAccessControl-RoleGranted-bytes32-address-address-[`++RoleGranted++`]]
@@ -397,7 +397,7 @@ Requirements:
 
 [.contract-item]
 [[IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-]]
-==== `[.contract-item-name]#++RoleAdminChanged++#++(bytes32 role, bytes32 previousAdminRole, bytes32 newAdminRole)++` [.item-kind]#event#
+==== `[.contract-item-name]#++RoleAdminChanged++#++(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)++` [.item-kind]#event#
 
 Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
 
@@ -408,7 +408,7 @@ _Available since v3.1._
 
 [.contract-item]
 [[IAccessControl-RoleGranted-bytes32-address-address-]]
-==== `[.contract-item-name]#++RoleGranted++#++(bytes32 role, address account, address sender)++` [.item-kind]#event#
+==== `[.contract-item-name]#++RoleGranted++#++(bytes32 indexed role, address indexed account, address indexed sender)++` [.item-kind]#event#
 
 Emitted when `account` is granted `role`.
 
@@ -417,7 +417,7 @@ bearer except when using {AccessControl-_setupRole}.
 
 [.contract-item]
 [[IAccessControl-RoleRevoked-bytes32-address-address-]]
-==== `[.contract-item-name]#++RoleRevoked++#++(bytes32 role, address account, address sender)++` [.item-kind]#event#
+==== `[.contract-item-name]#++RoleRevoked++#++(bytes32 indexed role, address indexed account, address indexed sender)++` [.item-kind]#event#
 
 Emitted when `account` is revoked `role`.
 
diff --git a/docs/modules/api/pages/finance.adoc b/docs/modules/api/pages/finance.adoc
index 646fb0fa0..14600529a 100644
--- a/docs/modules/api/pages/finance.adoc
+++ b/docs/modules/api/pages/finance.adoc
@@ -236,7 +236,7 @@ contract.
 
 [.contract-item]
 [[PaymentSplitter-ERC20PaymentReleased-contract-IERC20-address-uint256-]]
-==== `[.contract-item-name]#++ERC20PaymentReleased++#++(contract IERC20 token, address to, uint256 amount)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ERC20PaymentReleased++#++(contract IERC20 indexed token, address to, uint256 amount)++` [.item-kind]#event#
 
 [.contract-item]
 [[PaymentSplitter-PaymentReceived-address-uint256-]]
@@ -405,5 +405,5 @@ an asset given its total historical allocation.
 
 [.contract-item]
 [[VestingWallet-ERC20Released-address-uint256-]]
-==== `[.contract-item-name]#++ERC20Released++#++(address token, uint256 amount)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ERC20Released++#++(address indexed token, uint256 amount)++` [.item-kind]#event#
 
diff --git a/docs/modules/api/pages/governance.adoc b/docs/modules/api/pages/governance.adoc
index 79060f053..e10308d14 100644
--- a/docs/modules/api/pages/governance.adoc
+++ b/docs/modules/api/pages/governance.adoc
@@ -1086,7 +1086,7 @@ Emitted when a proposal is executed.
 
 [.contract-item]
 [[IGovernor-VoteCast-address-uint256-uint8-uint256-string-]]
-==== `[.contract-item-name]#++VoteCast++#++(address voter, uint256 proposalId, uint8 support, uint256 weight, string reason)++` [.item-kind]#event#
+==== `[.contract-item-name]#++VoteCast++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason)++` [.item-kind]#event#
 
 Emitted when a vote is cast without params.
 
@@ -1094,7 +1094,7 @@ Note: `support` values should be seen as buckets. Their interpretation depends o
 
 [.contract-item]
 [[IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-]]
-==== `[.contract-item-name]#++VoteCastWithParams++#++(address voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)++` [.item-kind]#event#
+==== `[.contract-item-name]#++VoteCastWithParams++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)++` [.item-kind]#event#
 
 Emitted when a vote is cast with params.
 
@@ -2999,7 +2999,7 @@ Emits a {LateQuorumVoteExtensionSet} event.
 
 [.contract-item]
 [[GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-]]
-==== `[.contract-item-name]#++ProposalExtended++#++(uint256 proposalId, uint64 extendedDeadline)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ProposalExtended++#++(uint256 indexed proposalId, uint64 extendedDeadline)++` [.item-kind]#event#
 
 Emitted when a proposal deadline is pushed back due to reaching quorum late in its voting period.
 
@@ -3930,19 +3930,19 @@ See {IERC1155Receiver-onERC1155BatchReceived}.
 
 [.contract-item]
 [[TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-]]
-==== `[.contract-item-name]#++CallScheduled++#++(bytes32 id, uint256 index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)++` [.item-kind]#event#
+==== `[.contract-item-name]#++CallScheduled++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)++` [.item-kind]#event#
 
 Emitted when a call is scheduled as part of operation `id`.
 
 [.contract-item]
 [[TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-]]
-==== `[.contract-item-name]#++CallExecuted++#++(bytes32 id, uint256 index, address target, uint256 value, bytes data)++` [.item-kind]#event#
+==== `[.contract-item-name]#++CallExecuted++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data)++` [.item-kind]#event#
 
 Emitted when a call is performed as part of operation `id`.
 
 [.contract-item]
 [[TimelockController-Cancelled-bytes32-]]
-==== `[.contract-item-name]#++Cancelled++#++(bytes32 id)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Cancelled++#++(bytes32 indexed id)++` [.item-kind]#event#
 
 Emitted when operation `id` is cancelled.
 
diff --git a/docs/modules/api/pages/interfaces.adoc b/docs/modules/api/pages/interfaces.adoc
index 40e40d33b..2d044f12c 100644
--- a/docs/modules/api/pages/interfaces.adoc
+++ b/docs/modules/api/pages/interfaces.adoc
@@ -737,9 +737,9 @@ Those methods should be performed separately.
 
 [.contract-item]
 [[IERC4626-Deposit-address-address-uint256-uint256-]]
-==== `[.contract-item-name]#++Deposit++#++(address sender, address owner, uint256 assets, uint256 shares)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Deposit++#++(address indexed sender, address indexed owner, uint256 assets, uint256 shares)++` [.item-kind]#event#
 
 [.contract-item]
 [[IERC4626-Withdraw-address-address-address-uint256-uint256-]]
-==== `[.contract-item-name]#++Withdraw++#++(address sender, address receiver, address owner, uint256 assets, uint256 shares)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Withdraw++#++(address indexed sender, address indexed receiver, address indexed owner, uint256 assets, uint256 shares)++` [.item-kind]#event#
 
diff --git a/docs/modules/api/pages/proxy.adoc b/docs/modules/api/pages/proxy.adoc
index fc9c3964c..baaca1b60 100644
--- a/docs/modules/api/pages/proxy.adoc
+++ b/docs/modules/api/pages/proxy.adoc
@@ -497,7 +497,7 @@ Emits a {BeaconUpgraded} event.
 
 [.contract-item]
 [[ERC1967Upgrade-Upgraded-address-]]
-==== `[.contract-item-name]#++Upgraded++#++(address implementation)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Upgraded++#++(address indexed implementation)++` [.item-kind]#event#
 
 Emitted when the implementation is upgraded.
 
@@ -509,7 +509,7 @@ Emitted when the admin account has changed.
 
 [.contract-item]
 [[ERC1967Upgrade-BeaconUpgraded-address-]]
-==== `[.contract-item-name]#++BeaconUpgraded++#++(address beacon)++` [.item-kind]#event#
+==== `[.contract-item-name]#++BeaconUpgraded++#++(address indexed beacon)++` [.item-kind]#event#
 
 Emitted when the beacon is upgraded.
 
@@ -1006,7 +1006,7 @@ Requirements:
 
 [.contract-item]
 [[UpgradeableBeacon-Upgraded-address-]]
-==== `[.contract-item-name]#++Upgraded++#++(address implementation)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Upgraded++#++(address indexed implementation)++` [.item-kind]#event#
 
 Emitted when the implementation returned by the beacon is changed.
 
diff --git a/docs/modules/api/pages/token/ERC1155.adoc b/docs/modules/api/pages/token/ERC1155.adoc
index 5b5e14bf0..4f9ad3ecc 100644
--- a/docs/modules/api/pages/token/ERC1155.adoc
+++ b/docs/modules/api/pages/token/ERC1155.adoc
@@ -390,27 +390,27 @@ acceptance magic value.
 
 [.contract-item]
 [[IERC1155-TransferSingle-address-address-address-uint256-uint256-]]
-==== `[.contract-item-name]#++TransferSingle++#++(address operator, address from, address to, uint256 id, uint256 value)++` [.item-kind]#event#
+==== `[.contract-item-name]#++TransferSingle++#++(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value)++` [.item-kind]#event#
 
 Emitted when `value` tokens of token type `id` are transferred from `from` to `to` by `operator`.
 
 [.contract-item]
 [[IERC1155-TransferBatch-address-address-address-uint256---uint256---]]
-==== `[.contract-item-name]#++TransferBatch++#++(address operator, address from, address to, uint256[] ids, uint256[] values)++` [.item-kind]#event#
+==== `[.contract-item-name]#++TransferBatch++#++(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values)++` [.item-kind]#event#
 
 Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
 transfers.
 
 [.contract-item]
 [[IERC1155-ApprovalForAll-address-address-bool-]]
-==== `[.contract-item-name]#++ApprovalForAll++#++(address account, address operator, bool approved)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ApprovalForAll++#++(address indexed account, address indexed operator, bool approved)++` [.item-kind]#event#
 
 Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
 `approved`.
 
 [.contract-item]
 [[IERC1155-URI-string-uint256-]]
-==== `[.contract-item-name]#++URI++#++(string value, uint256 id)++` [.item-kind]#event#
+==== `[.contract-item-name]#++URI++#++(string value, uint256 indexed id)++` [.item-kind]#event#
 
 Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
 
diff --git a/docs/modules/api/pages/token/ERC20.adoc b/docs/modules/api/pages/token/ERC20.adoc
index a0e282962..dbf432f42 100644
--- a/docs/modules/api/pages/token/ERC20.adoc
+++ b/docs/modules/api/pages/token/ERC20.adoc
@@ -647,7 +647,7 @@ Emits a {Transfer} event.
 
 [.contract-item]
 [[IERC20-Transfer-address-address-uint256-]]
-==== `[.contract-item-name]#++Transfer++#++(address from, address to, uint256 value)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Transfer++#++(address indexed from, address indexed to, uint256 value)++` [.item-kind]#event#
 
 Emitted when `value` tokens are moved from one account (`from`) to
 another (`to`).
@@ -656,7 +656,7 @@ Note that `value` may be zero.
 
 [.contract-item]
 [[IERC20-Approval-address-address-uint256-]]
-==== `[.contract-item-name]#++Approval++#++(address owner, address spender, uint256 value)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Approval++#++(address indexed owner, address indexed spender, uint256 value)++` [.item-kind]#event#
 
 Emitted when the allowance of a `spender` for an `owner` is set by
 a call to {approve}. `value` is the new allowance.
diff --git a/docs/modules/api/pages/token/ERC721.adoc b/docs/modules/api/pages/token/ERC721.adoc
index f009c3f26..7d7fe0403 100644
--- a/docs/modules/api/pages/token/ERC721.adoc
+++ b/docs/modules/api/pages/token/ERC721.adoc
@@ -677,19 +677,19 @@ See {setApprovalForAll}
 
 [.contract-item]
 [[IERC721-Transfer-address-address-uint256-]]
-==== `[.contract-item-name]#++Transfer++#++(address from, address to, uint256 tokenId)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Transfer++#++(address indexed from, address indexed to, uint256 indexed tokenId)++` [.item-kind]#event#
 
 Emitted when `tokenId` token is transferred from `from` to `to`.
 
 [.contract-item]
 [[IERC721-Approval-address-address-uint256-]]
-==== `[.contract-item-name]#++Approval++#++(address owner, address approved, uint256 tokenId)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Approval++#++(address indexed owner, address indexed approved, uint256 indexed tokenId)++` [.item-kind]#event#
 
 Emitted when `owner` enables `approved` to manage the `tokenId` token.
 
 [.contract-item]
 [[IERC721-ApprovalForAll-address-address-bool-]]
-==== `[.contract-item-name]#++ApprovalForAll++#++(address owner, address operator, bool approved)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ApprovalForAll++#++(address indexed owner, address indexed operator, bool approved)++` [.item-kind]#event#
 
 Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
 
diff --git a/docs/modules/api/pages/token/ERC777.adoc b/docs/modules/api/pages/token/ERC777.adoc
index b5747ea73..a0a6894b7 100644
--- a/docs/modules/api/pages/token/ERC777.adoc
+++ b/docs/modules/api/pages/token/ERC777.adoc
@@ -391,7 +391,7 @@ Requirements
 
 [.contract-item]
 [[IERC777-Minted-address-address-uint256-bytes-bytes-]]
-==== `[.contract-item-name]#++Minted++#++(address operator, address to, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Minted++#++(address indexed operator, address indexed to, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
 
 Emitted when `amount` tokens are created by `operator` and assigned to `to`.
 
@@ -399,7 +399,7 @@ Note that some additional user `data` and `operatorData` can be logged in the ev
 
 [.contract-item]
 [[IERC777-Burned-address-address-uint256-bytes-bytes-]]
-==== `[.contract-item-name]#++Burned++#++(address operator, address from, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Burned++#++(address indexed operator, address indexed from, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
 
 Emitted when `operator` destroys `amount` tokens from `account`.
 
@@ -407,19 +407,19 @@ Note that some additional user `data` and `operatorData` can be logged in the ev
 
 [.contract-item]
 [[IERC777-AuthorizedOperator-address-address-]]
-==== `[.contract-item-name]#++AuthorizedOperator++#++(address operator, address tokenHolder)++` [.item-kind]#event#
+==== `[.contract-item-name]#++AuthorizedOperator++#++(address indexed operator, address indexed tokenHolder)++` [.item-kind]#event#
 
 Emitted when `operator` is made operator for `tokenHolder`.
 
 [.contract-item]
 [[IERC777-RevokedOperator-address-address-]]
-==== `[.contract-item-name]#++RevokedOperator++#++(address operator, address tokenHolder)++` [.item-kind]#event#
+==== `[.contract-item-name]#++RevokedOperator++#++(address indexed operator, address indexed tokenHolder)++` [.item-kind]#event#
 
 Emitted when `operator` is revoked its operator status for `tokenHolder`.
 
 [.contract-item]
 [[IERC777-Sent-address-address-address-uint256-bytes-bytes-]]
-==== `[.contract-item-name]#++Sent++#++(address operator, address from, address to, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Sent++#++(address indexed operator, address indexed from, address indexed to, uint256 amount, bytes data, bytes operatorData)++` [.item-kind]#event#
 
 :_ERC1820_REGISTRY: pass:normal[xref:#ERC777-_ERC1820_REGISTRY-contract-IERC1820Registry[`++_ERC1820_REGISTRY++`]]
 :_balances: pass:normal[xref:#ERC777-_balances-mapping-address----uint256-[`++_balances++`]]
diff --git a/docs/modules/api/pages/utils.adoc b/docs/modules/api/pages/utils.adoc
index 684094962..6d16cfbaf 100644
--- a/docs/modules/api/pages/utils.adoc
+++ b/docs/modules/api/pages/utils.adoc
@@ -2568,11 +2568,11 @@ checks-effects-interactions pattern or using {ReentrancyGuard}.
 
 [.contract-item]
 [[Escrow-Deposited-address-uint256-]]
-==== `[.contract-item-name]#++Deposited++#++(address payee, uint256 weiAmount)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Deposited++#++(address indexed payee, uint256 weiAmount)++` [.item-kind]#event#
 
 [.contract-item]
 [[Escrow-Withdrawn-address-uint256-]]
-==== `[.contract-item-name]#++Withdrawn++#++(address payee, uint256 weiAmount)++` [.item-kind]#event#
+==== `[.contract-item-name]#++Withdrawn++#++(address indexed payee, uint256 weiAmount)++` [.item-kind]#event#
 
 :State: pass:normal[xref:#RefundEscrow-State[`++State++`]]
 :RefundsClosed: pass:normal[xref:#RefundEscrow-RefundsClosed--[`++RefundsClosed++`]]
@@ -3069,11 +3069,11 @@ https://eips.ethereum.org/EIPS/eip-1820#interface-name[section of the EIP].
 
 [.contract-item]
 [[IERC1820Registry-InterfaceImplementerSet-address-bytes32-address-]]
-==== `[.contract-item-name]#++InterfaceImplementerSet++#++(address account, bytes32 interfaceHash, address implementer)++` [.item-kind]#event#
+==== `[.contract-item-name]#++InterfaceImplementerSet++#++(address indexed account, bytes32 indexed interfaceHash, address indexed implementer)++` [.item-kind]#event#
 
 [.contract-item]
 [[IERC1820Registry-ManagerChanged-address-address-]]
-==== `[.contract-item-name]#++ManagerChanged++#++(address account, address newManager)++` [.item-kind]#event#
+==== `[.contract-item-name]#++ManagerChanged++#++(address indexed account, address indexed newManager)++` [.item-kind]#event#
 
 :canImplementInterfaceForAddress: pass:normal[xref:#IERC1820Implementer-canImplementInterfaceForAddress-bytes32-address-[`++canImplementInterfaceForAddress++`]]
 
diff --git a/docs/templates/helpers.js b/docs/templates/helpers.js
index 8c94d757c..4b3c58cc2 100644
--- a/docs/templates/helpers.js
+++ b/docs/templates/helpers.js
@@ -9,7 +9,7 @@ module.exports['readme-path'] = (opts) => {
 module.exports.names = (params) => params.map(p => p.name).join(', ');
 
 module.exports['typed-params'] = (params) => {
-  return params.map(p => `${p.type}${p.name ? ' ' + p.name : ''}`).join(', ');
+  return params?.map(p => `${p.type}${p.indexed ? ' indexed' : ''}${p.name ? ' ' + p.name : ''}`).join(', ');
 };
 
 const slug = module.exports.slug = (str) => {