From 537d1bbc014d15d1af36e2ca94d20647baf8cde5 Mon Sep 17 00:00:00 2001
From: Haythem Sellami <17862704+haythemsellami@users.noreply.github.com>
Date: Mon, 21 Oct 2024 11:03:31 +0700
Subject: [PATCH] natspec

---
 src/module/EulerEarnVault.sol | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/module/EulerEarnVault.sol b/src/module/EulerEarnVault.sol
index f8ae8730..da2897e9 100644
--- a/src/module/EulerEarnVault.sol
+++ b/src/module/EulerEarnVault.sol
@@ -927,6 +927,10 @@ abstract contract EulerEarnVaultModule is ERC4626Upgradeable, ERC20VotesUpgradea
 
     /// @dev Calculate the maximum amount of the underlying asset that can be withdrawn from the owner balance,
     ///      while simulating a harvest call before withdraw, returning the amounts of totalAssets and totalSupply to be expected.
+    /// @param _owner Owner address.
+    /// @return Expected totalAssets() after a harvest simulation.
+    /// @return Expected totalSupply() after a harvest simulation.
+    /// @return Max assets to withdraw.
     function _maxWithdraw(address _owner) private view returns (uint256, uint256, uint256) {
         uint256 ownerShares = _balanceOf(_owner);
         uint256 assetsBeforeHarvest = _convertToAssets(ownerShares, Math.Rounding.Floor);