📚(Vaults): more consistency on recover comments

lidofinance · Jun 27, 2023 · 21b05c6 · 21b05c6
1 parent d941ba1
commit 21b05c6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/contracts/0.8.9/LidoExecutionLayerRewardsVault.sol b/contracts/0.8.9/LidoExecutionLayerRewardsVault.sol
@@ -94,12 +94,12 @@ contract LidoExecutionLayerRewardsVault {
     }
 
     /**
-      * Transfers a given `_amount` of an ERC20-token (defined by the `_token` contract address)
-      * currently belonging to the burner contract address to the Lido treasury address.
-      *
-      * @param _token an ERC20-compatible token
-      * @param _amount token amount
-      */
+     * @notice Transfers a given `_amount` of an ERC20-token (defined by the `_token` contract address)
+     * currently belonging to the vault contract address to the Lido treasury address.
+     *
+     * @param _token an ERC20-compatible token
+     * @param _amount token amount
+     */
     function recoverERC20(address _token, uint256 _amount) external {
         require(_amount > 0, "ZERO_RECOVERY_AMOUNT");
 
@@ -109,12 +109,12 @@ contract LidoExecutionLayerRewardsVault {
     }
 
     /**
-      * Transfers a given token_id of an ERC721-compatible NFT (defined by the token contract address)
-      * currently belonging to the burner contract address to the Lido treasury address.
-      *
-      * @param _token an ERC721-compatible token
-      * @param _tokenId minted token id
-      */
+     * @notice Transfers the given tokenId of the ERC721-compatible NFT (defined by the provided token contract address)
+     * currently belonging to the vault contract address to the Lido treasury address.
+     *
+     * @param _token an ERC721-compatible token
+     * @param _tokenId minted token id
+     */
     function recoverERC721(address _token, uint256 _tokenId) external {
         emit ERC721Recovered(msg.sender, _token, _tokenId);
 

diff --git a/contracts/0.8.9/WithdrawalVault.sol b/contracts/0.8.9/WithdrawalVault.sol
@@ -30,13 +30,13 @@ contract WithdrawalVault is Versioned {
 
     // Events
     /**
-     * Emitted when the ERC20 `token` recovered (i.e. transferred)
+     * @notice Emitted when the ERC20 `token` recovered (i.e. transferred)
      * to the Lido treasury address by `requestedBy` sender.
      */
     event ERC20Recovered(address indexed requestedBy, address indexed token, uint256 amount);
 
     /**
-     * Emitted when the ERC721-compatible `token` (NFT) recovered (i.e. transferred)
+     * @notice Emitted when the ERC721-compatible `token` (NFT) recovered (i.e. transferred)
      * to the Lido treasury address by `requestedBy` sender.
      */
     event ERC721Recovered(address indexed requestedBy, address indexed token, uint256 tokenId);
@@ -94,8 +94,8 @@ contract WithdrawalVault is Versioned {
     }
 
     /**
-     * Transfers a given `_amount` of an ERC20-token (defined by the `_token` contract address)
-     * currently belonging to the burner contract address to the Lido treasury address.
+     * @notice Transfers a given `_amount` of an ERC20-token (defined by the `_token` contract address)
+     * currently belonging to the vault contract address to the Lido treasury address.
      *
      * @param _token an ERC20-compatible token
      * @param _amount token amount
@@ -111,8 +111,8 @@ contract WithdrawalVault is Versioned {
     }
 
     /**
-     * Transfers a given token_id of an ERC721-compatible NFT (defined by the token contract address)
-     * currently belonging to the burner contract address to the Lido treasury address.
+     * @notice Transfers the given tokenId of the ERC721-compatible NFT (defined by the provided token contract address)
+     * currently belonging to the vault contract address to the Lido treasury address.
      *
      * @param _token an ERC721-compatible token
      * @param _tokenId minted token id