- Misc doc fixes

This commit is contained in:
eboado 2020-11-26 10:37:04 +01:00
parent 3ef75e4018
commit a27239129f
4 changed files with 13 additions and 13 deletions

View File

@ -3,7 +3,7 @@ pragma solidity 0.6.12;
/** /**
* @title IDelegationToken * @title IDelegationToken
* @dev Implements an interface for tokens that have a delegation function * @dev Implements an interface for tokens with delegation COMP/UNI compatible
* @author Aave * @author Aave
**/ **/
interface IDelegationToken { interface IDelegationToken {

View File

@ -3,18 +3,18 @@ pragma solidity 0.6.12;
interface IScaledBalanceToken { interface IScaledBalanceToken {
/** /**
* @dev Returns the principal balance of the user. The principal balance is the last * @dev Returns the scaled balance of the user. The scaled balance is the sum of all the
* updated stored balance, which does not consider the perpetually accruing interest. * updated stored balance divided by the reserve's liquidity index at the moment of the update
* @param user The address of the user * @param user The user whose balance is calculated
* @return The principal balance of the user * @return The scaled balance of the user
**/ **/
function scaledBalanceOf(address user) external view returns (uint256); function scaledBalanceOf(address user) external view returns (uint256);
/** /**
* @dev Returns the principal balance of the user and principal total supply. * @dev Returns the scaled balance of the user and the scaled total supply.
* @param user The address of the user * @param user The address of the user
* @return The principal balance of the user * @return The scaled balance of the user
* @return The principal total supply * @return The scaled balance and the scaled total supply
**/ **/
function getScaledUserBalanceAndSupply(address user) external view returns (uint256, uint256); function getScaledUserBalanceAndSupply(address user) external view returns (uint256, uint256);

View File

@ -12,7 +12,7 @@ interface IStableDebtToken {
/** /**
* @dev Emitted when new stable debt is minted * @dev Emitted when new stable debt is minted
* @param user The address of the user who triggered the minting * @param user The address of the user who triggered the minting
* @param onBehalfOf The recipient of aTokens * @param onBehalfOf The recipient of stable debt tokens
* @param amount The amount minted * @param amount The amount minted
* @param currentBalance The current balance of the user * @param currentBalance The current balance of the user
* @param balanceIncrease The increase in balance since the last action of the user * @param balanceIncrease The increase in balance since the last action of the user

View File

@ -199,10 +199,10 @@ contract AToken is VersionedInitializable, IncentivizedERC20, IAToken {
} }
/** /**
* @dev returns the principal balance of the user and principal total supply. * @dev Returns the scaled balance of the user and the scaled total supply.
* @param user the address of the user * @param user The address of the user
* @return the principal balance of the user * @return The scaled balance of the user
* @return the principal total supply * @return The scaled balance and the scaled total supply
**/ **/
function getScaledUserBalanceAndSupply(address user) function getScaledUserBalanceAndSupply(address user)
external external