Skip to content

Commit

Permalink
refactor: Add last docs updates on multiple files
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelmtzinf committed Sep 9, 2021
1 parent d29cbf5 commit 4416c92
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 23 deletions.
5 changes: 0 additions & 5 deletions contracts/interfaces/IPool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,6 @@ interface IPool {

/**
* @notice Emitted when a borrower is liquidated.
* @dev This event is emitted by the Pool via PoolCollateral manager using a DELEGATECALL.
This allows to have the events in the generated ABI for Pool.
* @param collateralAsset The address of the underlying asset used as collateral, to receive as result of the liquidation
* @param debtAsset The address of the underlying borrowed asset to be repaid with the liquidation
* @param user The address of the borrower getting liquidated
Expand All @@ -142,9 +140,6 @@ interface IPool {

/**
* @notice Emitted when the state of a reserve is updated.
* @dev This event is actually declared in the ReserveLogic library and emitted in the updateInterestRates() function.
* Since the function is internal, the event will actually be fired by the Pool contract.
* The event is therefore replicated here so it gets added to the Pool ABI
* @param reserve The address of the underlying asset of the reserve
* @param liquidityRate The new liquidity rate
* @param stableBorrowRate The new stable borrow rate
Expand Down
2 changes: 1 addition & 1 deletion contracts/mocks/tokens/MintableDelegationERC20.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ contract MintableDelegationERC20 is ERC20 {
}

/**
* @dev Function to mint tokensp
* @dev Function to mint tokens
* @param value The amount of tokens to mint.
* @return A boolean that indicates if the operation was successful.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pragma solidity 0.8.6;

/**
* @title VersionedInitializable
* @author Aave, inspired by the OpenZeppelin Initializable contract
* @notice Helper contract to implement initializer functions. To use it, replace
* the constructor with a function that has the `initializer` modifier.
* @dev WARNING: Unlike constructors, initializer functions must be manually
Expand All @@ -11,7 +12,6 @@ pragma solidity 0.8.6;
* WARNING: When used with inheritance, manual care must be taken to not invoke
* a parent initializer twice, or ensure that all initializers are idempotent,
* because this is not dealt with automatically as with constructors.
* @author Aave, inspired by the OpenZeppelin Initializable contract
*/
abstract contract VersionedInitializable {
/**
Expand Down
6 changes: 3 additions & 3 deletions contracts/protocol/libraries/logic/LiquidationLogic.sol
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ library LiquidationLogic {
}

/**
* @dev Function to liquidate a position if its Health Factor drops below 1
* - The caller (liquidator) covers `debtToCover` amount of debt of the user getting liquidated, and receives
* a proportionally amount of the `collateralAsset` plus a bonus to cover market risk
* @dev Function to liquidate a position if its Health Factor drops below 1. The caller (liquidator)
* covers `debtToCover` amount of debt of the user getting liquidated, and receives
* a proportionally amount of the `collateralAsset` plus a bonus to cover market risk
**/
function executeLiquidationCall(
mapping(address => DataTypes.ReserveData) storage reserves,
Expand Down
8 changes: 4 additions & 4 deletions contracts/protocol/pool/Pool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import {PoolStorage} from './PoolStorage.sol';

/**
* @title Pool contract
* @author Aave
* @notice Main point of interaction with an Aave protocol's market
* - Users can:
* # Deposit
Expand All @@ -33,10 +34,9 @@ import {PoolStorage} from './PoolStorage.sol';
* # Enable/disable their deposits as collateral rebalance stable rate borrow positions
* # Liquidate positions
* # Execute Flash Loans
* @dev - To be covered by a proxy contract, owned by the PoolAddressesProvider of the specific market
* - All admin functions are callable by the PoolConfigurator contract defined also in the
* @dev To be covered by a proxy contract, owned by the PoolAddressesProvider of the specific market
* @dev All admin functions are callable by the PoolConfigurator contract defined also in the
* PoolAddressesProvider
* @author Aave
**/
contract Pool is VersionedInitializable, IPool, PoolStorage {
using WadRayMath for uint256;
Expand Down Expand Up @@ -67,7 +67,7 @@ contract Pool is VersionedInitializable, IPool, PoolStorage {
* @notice Initializes the Pool.
* @dev Function is invoked by the proxy contract when the Pool contract is added to the
* PoolAddressesProvider of the market.
* - Caching the address of the PoolAddressesProvider in order to reduce gas consumption
* @dev Caching the address of the PoolAddressesProvider in order to reduce gas consumption
* on subsequent operations
* @param provider The address of the PoolAddressesProvider
**/
Expand Down
6 changes: 3 additions & 3 deletions contracts/protocol/tokenization/AToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ contract AToken is
}

/**
* @dev Returns the address of the Aave treasury, receiving the fees on this aToken
* @notice Returns the address of the Aave treasury, receiving the fees on this aToken
* @return Address of the Aave treasury
**/
function RESERVE_TREASURY_ADDRESS() public view returns (address) {
Expand All @@ -225,7 +225,7 @@ contract AToken is
}

/**
* @dev Returns the address of the pool where this aToken is used
* @notice Returns the address of the pool where this aToken is used
* @return Address of the pool
**/
function POOL() public view returns (IPool) {
Expand Down Expand Up @@ -304,7 +304,7 @@ contract AToken is
}

/**
* @dev Overrides the parent _transfer to force validated transfer() and transferFrom()
* @notice Overrides the parent _transfer to force validated transfer() and transferFrom()
* @param from The source address
* @param to The destination address
* @param amount The amount getting transferred
Expand Down
8 changes: 4 additions & 4 deletions contracts/protocol/tokenization/IncentivizedERC20.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import {IAaveIncentivesController} from '../../interfaces/IAaveIncentivesControl

/**
* @title IncentivizedERC20
* @notice Basic ERC20 implementation
* @author Aave, inspired by the Openzeppelin ERC20 implementation
* @notice Basic ERC20 implementation
**/
abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
mapping(address => uint256) internal _balances;
Expand Down Expand Up @@ -57,7 +57,7 @@ abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
}

/**
* @dev Returns the address of the incentives controller contract
* @notice Returns the address of the incentives controller contract
* @return Incentivescontroller
**/
function getIncentivesController() external view virtual returns (IAaveIncentivesController) {
Expand Down Expand Up @@ -99,7 +99,7 @@ abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
}

/**
* @dev Increases the allowance of spender to spend _msgSender() tokens
* @notice Increases the allowance of spender to spend _msgSender() tokens
* @param spender The user allowed to spend on behalf of _msgSender()
* @param addedValue The amount being added to the allowance
* @return `true`
Expand All @@ -110,7 +110,7 @@ abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
}

/**
* @dev Decreases the allowance of spender to spend _msgSender() tokens
* @notice Decreases the allowance of spender to spend _msgSender() tokens
* @param spender The user allowed to spend on behalf of _msgSender()
* @param subtractedValue The amount being subtracted to the allowance
* @return `true`
Expand Down
4 changes: 2 additions & 2 deletions contracts/protocol/tokenization/StableDebtToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ contract StableDebtToken is IStableDebtToken, DebtTokenBase {
}

/**
* @dev Calculates the increase in balance since the last user interaction
* @notice Calculates the increase in balance since the last user interaction
* @param user The address of the user for which the interest is being accumulated
* @return The previous principal balance
* @return The new principal balance
Expand Down Expand Up @@ -367,7 +367,7 @@ contract StableDebtToken is IStableDebtToken, DebtTokenBase {
}

/**
* @dev Burns stable debt tokens of a user
* @notice Burns stable debt tokens of a user
* @param account The user getting his debt burned
* @param amount The amount being burned
* @param oldTotalSupply The total supply before the burning event
Expand Down

0 comments on commit 4416c92

Please sign in to comment.