Adding minor comments for implemented functions

thesis · Nov 30, 2023 · bf767b6 · bf767b6
1 parent d5a5014
commit bf767b6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/core/contracts/AcreRouter.sol b/core/contracts/AcreRouter.sol
@@ -44,19 +44,25 @@ contract AcreRouter is OwnableUpgradeable {
         tBTC = _tBTC;
     }
 
+    /// @notice Sets the Acre Manager address.
+    /// @param manager Address of the Acre Manager.
     function setAcreManager(address manager) external onlyOwner {
         require(manager != address(0), "Cannot be zero address");
         acreManager = manager;
         emit AcreManagerSet(manager);
     }
 
+    /// @notice Adds a vault to the list of approved vaults.
+    /// @param vault Address of the vault to add.
     function addVault(address vault) external onlyAcreManager {
         require(!isVault[vault], "Vault already exists");
         vaults.push(vault);
         isVault[vault] = true;
         emit VaultAdded(vault);
     }
 
+    /// @notice Removes a vault from the list of approved vaults.
+    /// @param vault Address of the vault to remove.
     function removeVault(address vault) external onlyAcreManager {
         require(isVault[vault], "Not an vault");