Skip to content

Commit 7c32748

Browse files
Krishang NadgaudaKrishang Nadgauda
Krishang Nadgauda
authored and
Krishang Nadgauda
committed
docs update
1 parent 40a6933 commit 7c32748

File tree

75 files changed

+2326
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2326
-114
lines changed

‎docs/AccessControl.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ function grantRole(bytes32 role, address account) external nonpayable
5757

5858

5959

60-
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role.*
60+
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleGranted} event.*
6161

6262
#### Parameters
6363

@@ -97,7 +97,7 @@ function renounceRole(bytes32 role, address account) external nonpayable
9797

9898

9999

100-
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`.*
100+
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`. May emit a {RoleRevoked} event.*
101101

102102
#### Parameters
103103

@@ -114,7 +114,7 @@ function revokeRole(bytes32 role, address account) external nonpayable
114114

115115

116116

117-
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role.*
117+
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleRevoked} event.*
118118

119119
#### Parameters
120120

‎docs/AccessControlEnumerable.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ function grantRole(bytes32 role, address account) external nonpayable
102102

103103

104104

105-
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role.*
105+
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleGranted} event.*
106106

107107
#### Parameters
108108

@@ -142,7 +142,7 @@ function renounceRole(bytes32 role, address account) external nonpayable
142142

143143

144144

145-
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`.*
145+
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`. May emit a {RoleRevoked} event.*
146146

147147
#### Parameters
148148

@@ -159,7 +159,7 @@ function revokeRole(bytes32 role, address account) external nonpayable
159159

160160

161161

162-
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role.*
162+
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleRevoked} event.*
163163

164164
#### Parameters
165165

‎docs/AccessControlEnumerableUpgradeable.md‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ function grantRole(bytes32 role, address account) external nonpayable
102102

103103

104104

105-
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role.*
105+
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleGranted} event.*
106106

107107
#### Parameters
108108

@@ -142,7 +142,7 @@ function renounceRole(bytes32 role, address account) external nonpayable
142142

143143

144144

145-
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`.*
145+
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`. May emit a {RoleRevoked} event.*
146146

147147
#### Parameters
148148

@@ -159,7 +159,7 @@ function revokeRole(bytes32 role, address account) external nonpayable
159159

160160

161161

162-
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role.*
162+
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleRevoked} event.*
163163

164164
#### Parameters
165165

@@ -194,6 +194,22 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)
194194

195195
## Events
196196

197+
### Initialized
198+
199+
```solidity
200+
event Initialized(uint8 version)
201+
```
202+
203+
204+
205+
206+
207+
#### Parameters
208+
209+
| Name | Type | Description |
210+
|---|---|---|
211+
| version | uint8 | undefined |
212+
197213
### RoleAdminChanged
198214

199215
```solidity

‎docs/AccessControlUpgradeable.md‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ function grantRole(bytes32 role, address account) external nonpayable
5757

5858

5959

60-
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role.*
60+
*Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleGranted} event.*
6161

6262
#### Parameters
6363

@@ -97,7 +97,7 @@ function renounceRole(bytes32 role, address account) external nonpayable
9797

9898

9999

100-
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`.*
100+
*Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`. May emit a {RoleRevoked} event.*
101101

102102
#### Parameters
103103

@@ -114,7 +114,7 @@ function revokeRole(bytes32 role, address account) external nonpayable
114114

115115

116116

117-
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role.*
117+
*Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have ``role``'s admin role. May emit a {RoleRevoked} event.*
118118

119119
#### Parameters
120120

@@ -149,6 +149,22 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)
149149

150150
## Events
151151

152+
### Initialized
153+
154+
```solidity
155+
event Initialized(uint8 version)
156+
```
157+
158+
159+
160+
161+
162+
#### Parameters
163+
164+
| Name | Type | Description |
165+
|---|---|---|
166+
| version | uint8 | undefined |
167+
152168
### RoleAdminChanged
153169

154170
```solidity

‎docs/AirdropERC1155.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,22 @@ Emitted when an airdrop payment is made to a recipient.
469469
| recipient `indexed` | address | undefined |
470470
| content | IAirdropERC1155.AirdropContent | undefined |
471471

472+
### Initialized
473+
474+
```solidity
475+
event Initialized(uint8 version)
476+
```
477+
478+
479+
480+
481+
482+
#### Parameters
483+
484+
| Name | Type | Description |
485+
|---|---|---|
486+
| version | uint8 | undefined |
487+
472488
### OwnerUpdated
473489

474490
```solidity

‎docs/AirdropERC1155Claimable.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,22 @@ function verifyClaim(address _claimer, uint256 _quantity, uint256 _tokenId, byte
351351

352352
## Events
353353

354+
### Initialized
355+
356+
```solidity
357+
event Initialized(uint8 version)
358+
```
359+
360+
361+
362+
363+
364+
#### Parameters
365+
366+
| Name | Type | Description |
367+
|---|---|---|
368+
| version | uint8 | undefined |
369+
354370
### OwnerUpdated
355371

356372
```solidity

‎docs/AirdropERC20.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,22 @@ Emitted when an airdrop payment is made to a recipient.
451451
| recipient `indexed` | address | undefined |
452452
| content | IAirdropERC20.AirdropContent | undefined |
453453

454+
### Initialized
455+
456+
```solidity
457+
event Initialized(uint8 version)
458+
```
459+
460+
461+
462+
463+
464+
#### Parameters
465+
466+
| Name | Type | Description |
467+
|---|---|---|
468+
| version | uint8 | undefined |
469+
454470
### OwnerUpdated
455471

456472
```solidity

‎docs/AirdropERC20Claimable.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,22 @@ function verifyClaim(address _claimer, uint256 _quantity, bytes32[] _proofs, uin
310310

311311
## Events
312312

313+
### Initialized
314+
315+
```solidity
316+
event Initialized(uint8 version)
317+
```
318+
319+
320+
321+
322+
323+
#### Parameters
324+
325+
| Name | Type | Description |
326+
|---|---|---|
327+
| version | uint8 | undefined |
328+
313329
### OwnerUpdated
314330

315331
```solidity

‎docs/AirdropERC721.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,22 @@ Emitted when an airdrop payment is made to a recipient.
451451
| recipient `indexed` | address | undefined |
452452
| content | IAirdropERC721.AirdropContent | undefined |
453453

454+
### Initialized
455+
456+
```solidity
457+
event Initialized(uint8 version)
458+
```
459+
460+
461+
462+
463+
464+
#### Parameters
465+
466+
| Name | Type | Description |
467+
|---|---|---|
468+
| version | uint8 | undefined |
469+
454470
### OwnerUpdated
455471

456472
```solidity

‎docs/AirdropERC721Claimable.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,22 @@ function verifyClaim(address _claimer, uint256 _quantity, bytes32[] _proofs, uin
349349

350350
## Events
351351

352+
### Initialized
353+
354+
```solidity
355+
event Initialized(uint8 version)
356+
```
357+
358+
359+
360+
361+
362+
#### Parameters
363+
364+
| Name | Type | Description |
365+
|---|---|---|
366+
| version | uint8 | undefined |
367+
352368
### OwnerUpdated
353369

354370
```solidity

0 commit comments

Comments
 (0)