Fix documentation of functions in interfaces directory

staringispolite · Aug 6, 2021 · 6618f9f · 6618f9f
1 parent 7fcacb5
commit 6618f9f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/contracts/interfaces/IERC1363.sol b/contracts/interfaces/IERC1363.sol
@@ -23,15 +23,15 @@ interface IERC1363 is IERC165, IERC20 {
      */
 
     /**
-     * @notice Transfer tokens from `msg.sender` to another address and then call `onTransferReceived` on receiver
+     * @dev Transfer tokens from `msg.sender` to another address and then call `onTransferReceived` on receiver
      * @param to address The address which you want to transfer to
      * @param value uint256 The amount of tokens to be transferred
      * @return true unless throwing
      */
     function transferAndCall(address to, uint256 value) external returns (bool);
 
     /**
-     * @notice Transfer tokens from `msg.sender` to another address and then call `onTransferReceived` on receiver
+     * @dev Transfer tokens from `msg.sender` to another address and then call `onTransferReceived` on receiver
      * @param to address The address which you want to transfer to
      * @param value uint256 The amount of tokens to be transferred
      * @param data bytes Additional data with no specified format, sent in call to `to`
@@ -44,7 +44,7 @@ interface IERC1363 is IERC165, IERC20 {
     ) external returns (bool);
 
     /**
-     * @notice Transfer tokens from one address to another and then call `onTransferReceived` on receiver
+     * @dev Transfer tokens from one address to another and then call `onTransferReceived` on receiver
      * @param from address The address which you want to send tokens from
      * @param to address The address which you want to transfer to
      * @param value uint256 The amount of tokens to be transferred
@@ -57,7 +57,7 @@ interface IERC1363 is IERC165, IERC20 {
     ) external returns (bool);
 
     /**
-     * @notice Transfer tokens from one address to another and then call `onTransferReceived` on receiver
+     * @dev Transfer tokens from one address to another and then call `onTransferReceived` on receiver
      * @param from address The address which you want to send tokens from
      * @param to address The address which you want to transfer to
      * @param value uint256 The amount of tokens to be transferred
@@ -72,15 +72,15 @@ interface IERC1363 is IERC165, IERC20 {
     ) external returns (bool);
 
     /**
-     * @notice Approve the passed address to spend the specified amount of tokens on behalf of msg.sender
+     * @dev Approve the passed address to spend the specified amount of tokens on behalf of msg.sender
      * and then call `onApprovalReceived` on spender.
      * @param spender address The address which will spend the funds
      * @param value uint256 The amount of tokens to be spent
      */
     function approveAndCall(address spender, uint256 value) external returns (bool);
 
     /**
-     * @notice Approve the passed address to spend the specified amount of tokens on behalf of msg.sender
+     * @dev Approve the passed address to spend the specified amount of tokens on behalf of msg.sender
      * and then call `onApprovalReceived` on spender.
      * @param spender address The address which will spend the funds
      * @param value uint256 The amount of tokens to be spent

diff --git a/contracts/interfaces/IERC2981.sol b/contracts/interfaces/IERC2981.sol
@@ -9,7 +9,7 @@ import "./IERC165.sol";
  */
 interface IERC2981 is IERC165 {
     /**
-     * @notice Called with the sale price to determine how much royalty is owed and to whom.
+     * @dev Called with the sale price to determine how much royalty is owed and to whom.
      * @param tokenId - the NFT asset queried for royalty information
      * @param salePrice - the sale price of the NFT asset specified by `tokenId`
      * @return receiver - address of who should be sent the royalty payment