Skip to content

Commit

Permalink
refactor: generate local links for @param & @return (#793)
Browse files Browse the repository at this point in the history
* refactor: local links for `@param` & `@return`

* docs: update auto-generated docs
  • Loading branch information
b00ste authored Nov 6, 2023
1 parent acf0a72 commit d3f26ea
Show file tree
Hide file tree
Showing 19 changed files with 148 additions and 148 deletions.
8 changes: 4 additions & 4 deletions docs/contracts/LSP0ERC725Account/LSP0ERC725Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -1472,11 +1472,11 @@ Emitted when the [`universalReceiver`](#universalreceiver) function was called w

| Name | Type | Description |
| ---------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the {universalReceiver(...)} function. |
| `value` **`indexed`** | `uint256` | The amount sent to the {universalReceiver(...)} function. |
| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the [`universalReceiver(...)`](#universalreceiver) function. |
| `value` **`indexed`** | `uint256` | The amount sent to the [`universalReceiver(...)`](#universalreceiver) function. |
| `typeId` **`indexed`** | `bytes32` | A `bytes32` unique identifier (= _"hook"_)that describe the type of notification, information or transaction received by the contract. Can be related to a specific standard or a hook. |
| `receivedData` | `bytes` | Any arbitrary data that was sent to the {universalReceiver(...)} function. |
| `returnedValue` | `bytes` | The value returned by the {universalReceiver(...)} function. |
| `receivedData` | `bytes` | Any arbitrary data that was sent to the [`universalReceiver(...)`](#universalreceiver) function. |
| `returnedValue` | `bytes` | The value returned by the [`universalReceiver(...)`](#universalreceiver) function. |

<br/>

Expand Down
14 changes: 7 additions & 7 deletions docs/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ The address of the signer will be recovered using the LSP25 signature format.

#### Parameters

| Name | Type | Description |
| -------------------- | :-------: | ----------------------------------------------------------------------------------------------------------------------- |
| `signature` | `bytes` | A 65 bytes long signature generated according to the signature format specified in the LSP25 standard. |
| `nonce` | `uint256` | The nonce that the signer used to generate the `signature`. |
| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See {\_verifyValidityTimestamps} to learn more). |
| `msgValue` | `uint256` | The amount of native tokens intended to be sent for the relay transaction. |
| `callData` | `bytes` | The calldata to execute as a relay transaction that the signer signed for. |
| Name | Type | Description |
| -------------------- | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `signature` | `bytes` | A 65 bytes long signature generated according to the signature format specified in the LSP25 standard. |
| `nonce` | `uint256` | The nonce that the signer used to generate the `signature`. |
| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See [`_verifyValidityTimestamps`](#_verifyvaliditytimestamps) to learn more). |
| `msgValue` | `uint256` | The amount of native tokens intended to be sent for the relay transaction. |
| `callData` | `bytes` | The calldata to execute as a relay transaction that the signer signed for. |

#### Returns

Expand Down
Loading

0 comments on commit d3f26ea

Please sign in to comment.