Skip to content

Commit

Permalink
doc: update generated markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
amarinkovic committed Apr 6, 2023
1 parent d904b35 commit 96ed7ee
Show file tree
Hide file tree
Showing 4 changed files with 1,826 additions and 1,439 deletions.
39 changes: 39 additions & 0 deletions docs/facets/IAdminFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,42 @@ Check if object can be tokenized
| --- | --- | --- |
|`_objectId` | bytes32 | ID of the object|
<br></br>
### lockFunction
System Admin can lock a function
This toggles FunctionLockedStorage.lock to true
```solidity
function lockFunction(
bytes4 functionSelector
) external
```
#### Arguments:
| Argument | Type | Description |
| --- | --- | --- |
|`functionSelector` | bytes4 | the bytes4 function selector|
<br></br>
### unlockFunction
System Admin can unlock a function
This toggles FunctionLockedStorage.lock to false
```solidity
function unlockFunction(
bytes4 functionSelector
) external
```
#### Arguments:
| Argument | Type | Description |
| --- | --- | --- |
|`functionSelector` | bytes4 | the bytes4 function selector|
<br></br>
### isFunctionLocked
Check if a function has been locked by a system admin
This views FunctionLockedStorage.lock
```solidity
function isFunctionLocked(
bytes4 functionSelector
) external returns (bool)
```
#### Arguments:
| Argument | Type | Description |
| --- | --- | --- |
|`functionSelector` | bytes4 | the bytes4 function selector|
<br></br>
16 changes: 16 additions & 0 deletions docs/facets/IEntityFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,22 @@ Enable an entity to be tokenized
|`_symbol` | string | The symbol assigned to the entity token
|`_name` | string | The name assigned to the entity token|
<br></br>
### updateEntityTokenInfo
Update entity token name and symbol
```solidity
function updateEntityTokenInfo(
bytes32 _objectId,
string _symbol,
string _name
) external
```
#### Arguments:
| Argument | Type | Description |
| --- | --- | --- |
|`_objectId` | bytes32 | ID of the entity
|`_symbol` | string | New entity token symbol
|`_name` | string | New entity token name|
<br></br>
### startTokenSale
Start token sale of `_amount` tokens for total price of `_totalPrice`
Entity tokens are minted when the sale is started
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"glob": "^8.0.3",
"prettier": "^2.7.1",
"prettier-plugin-solidity": "^1.0.0-beta.19",
"solc": "^0.8.16",
"solc": "0.8.17",
"solhint": "^3.3.7",
"solidity-coverage": "^0.7.21",
"solidity-docgen": "^0.5.17"
Expand Down

0 comments on commit 96ed7ee

Please sign in to comment.