docs: improving natspec for the mint and burn functions

aave · Jan 3, 2022 · ef57d1b · ef57d1b
1 parent 5e9d2d2
commit ef57d1b
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/contracts/interfaces/IAToken.sol b/contracts/interfaces/IAToken.sol
@@ -54,8 +54,8 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
 
   /**
    * @notice Mints `amount` aTokens to `user`
-   * @param caller The address minting tokens
-   * @param onBehalfOf The address receiving the minted tokens
+   * @param caller The address performing the mint
+   * @param onBehalfOf The address of the user that will receive the minted aTokens
    * @param amount The amount of tokens getting minted
    * @param index The next liquidity index of the reserve
    * @return `true` if the the previous balance of the user was 0
@@ -71,7 +71,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
    * @notice Burns aTokens from `user` and sends the equivalent amount of underlying to `receiverOfUnderlying`
    * @dev In some instances, the mint event could be emitted from a burn transaction
    * if the amount to burn is less than the interest the user earned
-   * @param from The owner of the aTokens, getting them burned
+   * @param from The address from which the aTokens will be burned
    * @param receiverOfUnderlying The address that will receive the underlying
    * @param amount The amount being burned
    * @param index The next liquidity index of the reserve