Skip to content

Commit 33aad3a

Browse files
jarrodwattsjarrodwatts
authored
Configure dodoc to not generate node modules (#211)
1 parent 54e0c4b commit 33aad3a

File tree

214 files changed

+6207
-4779
lines changed

Some content is hidden

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

214 files changed

+6207
-4779
lines changed

‎docs/ContractPublisher.md‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
2525

2626
| Name | Type | Description |
2727
|---|---|---|
28-
| _0 | bytes32 | undefined
28+
| _0 | bytes32 | undefined |
2929

3030
### getAllPublishedContracts
3131

@@ -41,13 +41,13 @@ Returns the latest version of all contracts published by a publisher.
4141

4242
| Name | Type | Description |
4343
|---|---|---|
44-
| _publisher | address | undefined
44+
| _publisher | address | undefined |
4545

4646
#### Returns
4747

4848
| Name | Type | Description |
4949
|---|---|---|
50-
| published | IContractPublisher.CustomContractInstance[] | undefined
50+
| published | IContractPublisher.CustomContractInstance[] | undefined |
5151

5252
### getPublishedContract
5353

@@ -63,14 +63,14 @@ Returns the latest version of a contract published by a publisher.
6363

6464
| Name | Type | Description |
6565
|---|---|---|
66-
| _publisher | address | undefined
67-
| _contractId | string | undefined
66+
| _publisher | address | undefined |
67+
| _contractId | string | undefined |
6868

6969
#### Returns
7070

7171
| Name | Type | Description |
7272
|---|---|---|
73-
| published | IContractPublisher.CustomContractInstance | undefined
73+
| published | IContractPublisher.CustomContractInstance | undefined |
7474

7575
### getPublishedContractVersions
7676

@@ -86,14 +86,14 @@ Returns all versions of a published contract.
8686

8787
| Name | Type | Description |
8888
|---|---|---|
89-
| _publisher | address | undefined
90-
| _contractId | string | undefined
89+
| _publisher | address | undefined |
90+
| _contractId | string | undefined |
9191

9292
#### Returns
9393

9494
| Name | Type | Description |
9595
|---|---|---|
96-
| published | IContractPublisher.CustomContractInstance[] | undefined
96+
| published | IContractPublisher.CustomContractInstance[] | undefined |
9797

9898
### getPublishedUriFromCompilerUri
9999

@@ -109,13 +109,13 @@ Retrieve the published metadata URI from a compiler metadata URI
109109

110110
| Name | Type | Description |
111111
|---|---|---|
112-
| compilerMetadataUri | string | undefined
112+
| compilerMetadataUri | string | undefined |
113113

114114
#### Returns
115115

116116
| Name | Type | Description |
117117
|---|---|---|
118-
| publishedMetadataUris | string[] | undefined
118+
| publishedMetadataUris | string[] | undefined |
119119

120120
### getPublisherProfileUri
121121

@@ -131,13 +131,13 @@ Get the publisher profile uri for a given publisher.
131131

132132
| Name | Type | Description |
133133
|---|---|---|
134-
| publisher | address | undefined
134+
| publisher | address | undefined |
135135

136136
#### Returns
137137

138138
| Name | Type | Description |
139139
|---|---|---|
140-
| uri | string | undefined
140+
| uri | string | undefined |
141141

142142
### getRoleAdmin
143143

@@ -153,13 +153,13 @@ function getRoleAdmin(bytes32 role) external view returns (bytes32)
153153

154154
| Name | Type | Description |
155155
|---|---|---|
156-
| role | bytes32 | undefined
156+
| role | bytes32 | undefined |
157157

158158
#### Returns
159159

160160
| Name | Type | Description |
161161
|---|---|---|
162-
| _0 | bytes32 | undefined
162+
| _0 | bytes32 | undefined |
163163

164164
### getRoleMember
165165

@@ -175,14 +175,14 @@ function getRoleMember(bytes32 role, uint256 index) external view returns (addre
175175

176176
| Name | Type | Description |
177177
|---|---|---|
178-
| role | bytes32 | undefined
179-
| index | uint256 | undefined
178+
| role | bytes32 | undefined |
179+
| index | uint256 | undefined |
180180

181181
#### Returns
182182

183183
| Name | Type | Description |
184184
|---|---|---|
185-
| _0 | address | undefined
185+
| _0 | address | undefined |
186186

187187
### getRoleMemberCount
188188

@@ -198,13 +198,13 @@ function getRoleMemberCount(bytes32 role) external view returns (uint256)
198198

199199
| Name | Type | Description |
200200
|---|---|---|
201-
| role | bytes32 | undefined
201+
| role | bytes32 | undefined |
202202

203203
#### Returns
204204

205205
| Name | Type | Description |
206206
|---|---|---|
207-
| _0 | uint256 | undefined
207+
| _0 | uint256 | undefined |
208208

209209
### grantRole
210210

@@ -220,8 +220,8 @@ function grantRole(bytes32 role, address account) external nonpayable
220220

221221
| Name | Type | Description |
222222
|---|---|---|
223-
| role | bytes32 | undefined
224-
| account | address | undefined
223+
| role | bytes32 | undefined |
224+
| account | address | undefined |
225225

226226
### hasRole
227227

@@ -237,14 +237,14 @@ function hasRole(bytes32 role, address account) external view returns (bool)
237237

238238
| Name | Type | Description |
239239
|---|---|---|
240-
| role | bytes32 | undefined
241-
| account | address | undefined
240+
| role | bytes32 | undefined |
241+
| account | address | undefined |
242242

243243
#### Returns
244244

245245
| Name | Type | Description |
246246
|---|---|---|
247-
| _0 | bool | undefined
247+
| _0 | bool | undefined |
248248

249249
### isPaused
250250

@@ -261,7 +261,7 @@ Whether the contract publisher is paused.
261261

262262
| Name | Type | Description |
263263
|---|---|---|
264-
| _0 | bool | undefined
264+
| _0 | bool | undefined |
265265

266266
### isTrustedForwarder
267267

@@ -277,13 +277,13 @@ function isTrustedForwarder(address forwarder) external view returns (bool)
277277

278278
| Name | Type | Description |
279279
|---|---|---|
280-
| forwarder | address | undefined
280+
| forwarder | address | undefined |
281281

282282
#### Returns
283283

284284
| Name | Type | Description |
285285
|---|---|---|
286-
| _0 | bool | undefined
286+
| _0 | bool | undefined |
287287

288288
### multicall
289289

@@ -299,13 +299,13 @@ function multicall(bytes[] data) external nonpayable returns (bytes[] results)
299299

300300
| Name | Type | Description |
301301
|---|---|---|
302-
| data | bytes[] | undefined
302+
| data | bytes[] | undefined |
303303

304304
#### Returns
305305

306306
| Name | Type | Description |
307307
|---|---|---|
308-
| results | bytes[] | undefined
308+
| results | bytes[] | undefined |
309309

310310
### prevPublisher
311311

@@ -322,7 +322,7 @@ function prevPublisher() external view returns (contract IContractPublisher)
322322

323323
| Name | Type | Description |
324324
|---|---|---|
325-
| _0 | contract IContractPublisher | undefined
325+
| _0 | contract IContractPublisher | undefined |
326326

327327
### publishContract
328328

@@ -338,12 +338,12 @@ Let's an account publish a contract.
338338

339339
| Name | Type | Description |
340340
|---|---|---|
341-
| _publisher | address | undefined
342-
| _contractId | string | undefined
343-
| _publishMetadataUri | string | undefined
344-
| _compilerMetadataUri | string | undefined
345-
| _bytecodeHash | bytes32 | undefined
346-
| _implementation | address | undefined
341+
| _publisher | address | undefined |
342+
| _contractId | string | undefined |
343+
| _publishMetadataUri | string | undefined |
344+
| _compilerMetadataUri | string | undefined |
345+
| _bytecodeHash | bytes32 | undefined |
346+
| _implementation | address | undefined |
347347

348348
### renounceRole
349349

@@ -359,8 +359,8 @@ function renounceRole(bytes32 role, address account) external nonpayable
359359

360360
| Name | Type | Description |
361361
|---|---|---|
362-
| role | bytes32 | undefined
363-
| account | address | undefined
362+
| role | bytes32 | undefined |
363+
| account | address | undefined |
364364

365365
### revokeRole
366366

@@ -376,8 +376,8 @@ function revokeRole(bytes32 role, address account) external nonpayable
376376

377377
| Name | Type | Description |
378378
|---|---|---|
379-
| role | bytes32 | undefined
380-
| account | address | undefined
379+
| role | bytes32 | undefined |
380+
| account | address | undefined |
381381

382382
### setPause
383383

@@ -393,7 +393,7 @@ function setPause(bool _pause) external nonpayable
393393

394394
| Name | Type | Description |
395395
|---|---|---|
396-
| _pause | bool | undefined
396+
| _pause | bool | undefined |
397397

398398
### setPublisherProfileUri
399399

@@ -409,8 +409,8 @@ Lets an account set its own publisher profile uri
409409

410410
| Name | Type | Description |
411411
|---|---|---|
412-
| publisher | address | undefined
413-
| uri | string | undefined
412+
| publisher | address | undefined |
413+
| uri | string | undefined |
414414

415415
### supportsInterface
416416

@@ -426,13 +426,13 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)
426426

427427
| Name | Type | Description |
428428
|---|---|---|
429-
| interfaceId | bytes4 | undefined
429+
| interfaceId | bytes4 | undefined |
430430

431431
#### Returns
432432

433433
| Name | Type | Description |
434434
|---|---|---|
435-
| _0 | bool | undefined
435+
| _0 | bool | undefined |
436436

437437
### unpublishContract
438438

@@ -448,8 +448,8 @@ Lets a publisher unpublish a contract and all its versions.
448448

449449
| Name | Type | Description |
450450
|---|---|---|
451-
| _publisher | address | undefined
452-
| _contractId | string | undefined
451+
| _publisher | address | undefined |
452+
| _contractId | string | undefined |
453453

454454

455455

‎docs/ERC1155TokenReceiver.md‎

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)