diff --git a/src/contracts/AbstractARM.sol b/src/contracts/AbstractARM.sol index 1398410..2fd15d0 100644 --- a/src/contracts/AbstractARM.sol +++ b/src/contracts/AbstractARM.sol @@ -7,6 +7,10 @@ import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol"; import {OwnableOperable} from "./OwnableOperable.sol"; import {IERC20, ICapManager} from "./Interfaces.sol"; +/** + * @title Generic Automated Redemption Manager (ARM) + * @author Origin Protocol Inc + */ abstract contract AbstractARM is OwnableOperable, ERC20Upgradeable { //////////////////////////////////////////////////// /// Constants diff --git a/src/contracts/Ownable.sol b/src/contracts/Ownable.sol index 7e9b13f..5497637 100644 --- a/src/contracts/Ownable.sol +++ b/src/contracts/Ownable.sol @@ -1,6 +1,10 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.23; +/** + * @title Base contract that provides ownership control + * @author Origin Protocol Inc + */ contract Ownable { /// @notice The slot used to store the owner of the contract. /// This is also used as the proxy admin. diff --git a/src/contracts/OwnableOperable.sol b/src/contracts/OwnableOperable.sol index e2e0363..1fa43c1 100644 --- a/src/contracts/OwnableOperable.sol +++ b/src/contracts/OwnableOperable.sol @@ -3,6 +3,10 @@ pragma solidity ^0.8.23; import {Ownable} from "./Ownable.sol"; +/** + * @title Base contract that provides ownership and operational control + * @author Origin Protocol Inc + */ contract OwnableOperable is Ownable { /// @notice The account that can request and claim withdrawals. address public operator;