minor update comments

DODOEX · Jan 12, 2024 · 86d08ec · 86d08ec
1 parent 9da4b65
commit 86d08ec
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/contracts/DODOV3MM/D3Pool/D3Maker.sol b/contracts/DODOV3MM/D3Pool/D3Maker.sol
@@ -99,6 +99,7 @@ contract D3Maker is InitializableOwnable {
     /// @notice get all stable token Info
     /// @return numberOfStable stable tokens' quantity
     /// @return tokenPriceStable stable tokens' price slot array. each data contains up to 3 token prices
+    /// @return curFlag current flags for all token in one slot
     function getStableTokenInfo()
         external
         view
@@ -112,6 +113,7 @@ contract D3Maker is InitializableOwnable {
     /// @notice get all non-stable token Info
     /// @return number stable tokens' quantity
     /// @return tokenPrices stable tokens' price slot array. each data contains up to 3 token prices
+    /// @return curFlag current flags for all token in one slot
     function getNSTokenInfo() external view returns (uint256 number, uint256[] memory tokenPrices, uint256 curFlag) {
         number = state.priceListInfo.numberOfNS;
         tokenPrices = state.priceListInfo.tokenPriceNS;

diff --git a/contracts/DODOV3MM/D3Vault/D3VaultFunding.sol b/contracts/DODOV3MM/D3Vault/D3VaultFunding.sol
@@ -82,7 +82,7 @@ contract D3VaultFunding is D3VaultStorage {
 
     // ---------- Pool Fund ----------
 
-    /// @notice Pool borrow function
+    /// @notice Pool borrow function. This function can only be called by D3Pool.
     /// @param token The address of the token
     /// @param amount The amount of token to borrow
     function poolBorrow(address token, uint256 amount) external nonReentrant allowedToken(token) onlyPool {
@@ -106,7 +106,7 @@ contract D3VaultFunding is D3VaultStorage {
         emit PoolBorrow(msg.sender, token, amount, interests);
     }
 
-    /// @notice Pool repay function
+    /// @notice Pool repay function. This function can only be called by D3Pool.
     /// @param token The address of the token
     /// @param amount The amount of token to repay
     function poolRepay(address token, uint256 amount) external nonReentrant allowedToken(token) onlyPool {