diff --git a/src/interfaces/ISablierFlow.sol b/src/interfaces/ISablierFlow.sol index 593cb8cb..7239f8ee 100644 --- a/src/interfaces/ISablierFlow.sol +++ b/src/interfaces/ISablierFlow.sol @@ -164,7 +164,7 @@ interface ISablierFlow is /// @notice Changes the stream's rate per second. /// - /// @dev Emits {AdjustFlowStream} and {MetadataUpdate} events. + /// @dev Emits a {AdjustFlowStream} and {MetadataUpdate} event. /// /// Notes: /// - It updates snapshot debt and snapshot time. @@ -214,7 +214,7 @@ interface ISablierFlow is /// @notice Creates a new Flow stream by setting the snapshot time to `block.timestamp` and the balance to `amount`. /// The stream is wrapped in an ERC-721 NFT. /// - /// @dev Emits {Transfer}, {CreateFlowStream}, and {DepositFlowStream} events. + /// @dev Emits a {Transfer}, {CreateFlowStream}, and {DepositFlowStream} event. /// /// Notes: /// - Refer to the notes in {deposit}. @@ -245,7 +245,7 @@ interface ISablierFlow is /// @notice Makes a deposit in a stream. /// - /// @dev Emits {Transfer} and {DepositFlowStream} events. + /// @dev Emits a {Transfer} and {DepositFlowStream} event. /// /// Requirements: /// - Must not be delegate called. @@ -261,7 +261,7 @@ interface ISablierFlow is /// @notice Deposits tokens in a stream and pauses it. /// - /// @dev Emits {Transfer}, {DepositFlowStream} and {PauseFlowStream} events. + /// @dev Emits a {Transfer}, {DepositFlowStream} and {PauseFlowStream} event. /// /// Notes: /// - Refer to the notes in {deposit} and {pause}. @@ -275,7 +275,7 @@ interface ISablierFlow is /// @notice Deposits tokens in a stream. /// - /// @dev Emits {Transfer} and {DepositFlowStream} events. + /// @dev Emits a {Transfer} and {DepositFlowStream} event. /// /// Notes: /// - Refer to the notes in {deposit}. @@ -321,7 +321,7 @@ interface ISablierFlow is /// @notice Refunds the provided amount of tokens from the stream to the sender's address. /// - /// @dev Emits {Transfer} and {RefundFromFlowStream} events. + /// @dev Emits a {Transfer} and {RefundFromFlowStream} event. /// /// Requirements: /// - Must not be delegate called. @@ -335,7 +335,7 @@ interface ISablierFlow is /// @notice Refunds the provided amount of tokens from the stream to the sender's address. /// - /// @dev Emits {Transfer}, {RefundFromFlowStream} and {PauseFlowStream} events. + /// @dev Emits a {Transfer}, {RefundFromFlowStream} and {PauseFlowStream} event. /// /// Notes: /// - Refer to the notes in {pause}. @@ -349,7 +349,7 @@ interface ISablierFlow is /// @notice Refunds the entire refundable amount of tokens from the stream to the sender's address. /// - /// @dev Emits {Transfer} and {RefundFromFlowStream} events. + /// @dev Emits a {Transfer} and {RefundFromFlowStream} event. /// /// Requirements: /// - Refer to the requirements in {refund}. @@ -377,7 +377,7 @@ interface ISablierFlow is /// @notice Restarts the stream with the provided rate per second, and makes a deposit. /// - /// @dev Emits {RestartFlowStream}, {Transfer}, and {DepositFlowStream} events. + /// @dev Emits a {RestartFlowStream}, {Transfer}, and {DepositFlowStream} event. /// /// Notes: /// - Refer to the notes in {restart} and {deposit}. @@ -414,7 +414,7 @@ interface ISablierFlow is /// @notice Withdraws the provided `amount` minus the protocol fee to the provided `to` address. /// - /// @dev Emits {Transfer} and {WithdrawFromFlowStream} events. + /// @dev Emits a {Transfer} and {WithdrawFromFlowStream} event. /// /// Notes: /// - It sets the snapshot time to the `block.timestamp` if `amount` is greater than snapshot debt. @@ -444,7 +444,7 @@ interface ISablierFlow is /// @notice Withdraws the entire withdrawable amount minus the protocol fee to the provided `to` address. /// - /// @dev Emits {Transfer} and {WithdrawFromFlowStream} events. + /// @dev Emits a {Transfer} and {WithdrawFromFlowStream} event. /// /// Notes: /// - Refer to the notes in {withdraw}. diff --git a/src/interfaces/ISablierFlowBase.sol b/src/interfaces/ISablierFlowBase.sol index 16de29cb..54e606ba 100644 --- a/src/interfaces/ISablierFlowBase.sol +++ b/src/interfaces/ISablierFlowBase.sol @@ -155,12 +155,12 @@ interface ISablierFlowBase is /// @dev Emits a {CollectFees} event. /// /// Notes: - /// - If the admin is a contract, it must be able to receive ETH. + /// - If the admin is a contract, it must be able to receive native token payments, e.g., ETH for Ethereum Mainnet. function collectFees() external; /// @notice Collect the protocol revenue accrued for the provided ERC-20 token. /// - /// @dev Emits {CollectProtocolRevenue} event. + /// @dev Emits a {CollectProtocolRevenue} event. /// /// Requirements: /// - `msg.sender` must be the contract admin. @@ -172,7 +172,7 @@ interface ISablierFlowBase is /// @notice Recover the surplus amount of tokens. /// - /// @dev Emits {Recover} event. + /// @dev Emits a {Recover} event. /// /// Notes: /// - The surplus amount is defined as the difference between the total balance of the contract for the provided @@ -188,7 +188,7 @@ interface ISablierFlowBase is /// @notice Sets a new NFT descriptor contract, which produces the URI describing the Sablier stream NFTs. /// - /// @dev Emits {SetNFTDescriptor} and {BatchMetadataUpdate} events. + /// @dev Emits a {SetNFTDescriptor} and {BatchMetadataUpdate} event. /// /// Notes: /// - Does not revert if the NFT descriptor is the same. @@ -202,7 +202,7 @@ interface ISablierFlowBase is /// @notice Sets a new protocol fee that will be charged on all the withdrawals from streams created with the /// provided ERC-20 token. /// - /// @dev Emits {SetProtocolFee} and {BatchMetadataUpdate} events. + /// @dev Emits a {SetProtocolFee} and {BatchMetadataUpdate} event. /// /// Notes: /// - Does not revert if the fee is the same.