docs: update comments

vittominacori · Oct 18, 2023 · 895e6a2 · 895e6a2
1 parent 51d3496
commit 895e6a2
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/contracts/token/ERC1363/ERC1363.sol b/contracts/token/ERC1363/ERC1363.sol
@@ -13,6 +13,10 @@ import {IERC1363Spender} from "./IERC1363Spender.sol";
 /**
  * @title ERC1363
  * @dev Implementation of the ERC1363 interface.
+ * Extension of ERC20 tokens that adds support for code execution after transfers and approvals
+ * on recipient contracts in a single transaction.
+ * Calls after transfers are enabled through the `ERC1363-transferAndCall` and `ERC1363-transferFromAndCall`,
+ * while calls after approvals can be made with `ERC1363-approveAndCall`.
  */
 abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
     /**
@@ -76,7 +80,7 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
     }
 
     /**
-     * @dev Private function to invoke `onTransferReceived` on a target address.
+     * @dev Performs a call to `IERC1363Receiver-onTransferReceived` on a target address.
      * This will revert if the target doesn't implement the `IERC1363Receiver` interface or
      * if the target doesn't accept the token transfer or
      * if the target address is not a contract.
@@ -108,7 +112,7 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
     }
 
     /**
-     * @dev Private function to invoke `onApprovalReceived` on a target address.
+     * @dev Performs a call to `IERC1363Spender-onApprovalReceived` on a target address.
      * This will revert if the target doesn't implement the `IERC1363Spender` interface or
      * if the target doesn't accept the token approval or
      * if the target address is not a contract.