From 154f2271cfa83a8a375cff23c9cdef0f441efda9 Mon Sep 17 00:00:00 2001 From: RafaDSan Date: Tue, 25 Jun 2024 01:07:00 -0300 Subject: [PATCH] fix: added missing tables in the docs --- docs/solidity-docgen/interfaces/ISwaplace.md | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/solidity-docgen/interfaces/ISwaplace.md b/docs/solidity-docgen/interfaces/ISwaplace.md index e2ee438..8356ef4 100644 --- a/docs/solidity-docgen/interfaces/ISwaplace.md +++ b/docs/solidity-docgen/interfaces/ISwaplace.md @@ -44,6 +44,12 @@ Requirements: Emits a {SwapCreated} event._ +#### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| Swap | struct ISwap.Swap | is the Swap struct to be created. | + ### acceptSwap ```solidity @@ -65,6 +71,13 @@ Emits a {SwapAccepted} event. NOTE: The expiry is set to 0, because if the Swap is expired it will revert, preventing reentrancy attacks._ +#### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| swapId | uint256 | is the ID of the Swap to be accepted. | +| receiver | address | is the address that will receive the trading assets. | + ### cancelSwap ```solidity @@ -83,6 +96,12 @@ Requirements: Emits a {SwapCanceled} event._ +#### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| swapId | uint256 | is the ID of the Swap to be canceled. | + ### getSwap ```solidity @@ -95,3 +114,9 @@ NOTE: If the Swaps doesn't exist, the values will be defaulted to 0. You can check if a Swap exists by checking if the `owner` is the zero address. If the `owner` is the zero address, then the Swap doesn't exist._ +#### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| swapId | uint256 | is the ID of the Swap to be retrieved. | +