Skip to content

Commit

Permalink
docs: Fix typo in the closing part of multiline natspec docs (#764)
Browse files Browse the repository at this point in the history
* docs: Fix typo in the closing part of multiline natspec docs
  • Loading branch information
miguelmtzinf authored Dec 14, 2022
1 parent 56fd7ba commit 32f0e72
Show file tree
Hide file tree
Showing 57 changed files with 309 additions and 309 deletions.
4 changes: 2 additions & 2 deletions Certora/certora/harness/ATokenHarness.sol
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ contract ATokenHarness is AToken {
/**
* @dev Calls burn with index == 1 RAY
* @param amount the amount being burned
**/
*/
function burn(
address user,
address receiverOfUnderlying,
Expand All @@ -37,7 +37,7 @@ contract ATokenHarness is AToken {
/**
* @dev Calls mint with index == 1 RAY
* @param amount the amount of tokens to mint
**/
*/
function mint(
address user,
address onBehalfOf,
Expand Down
4 changes: 2 additions & 2 deletions Certora/certora/harness/GenericLogicHarness.sol
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ contract GenericLogic {
* @return The average liquidation threshold of the user
* @return The health factor of the user
* @return True if the ltv is zero, false otherwise
**/
*/
function calculateUserAccountData()
public
returns (
Expand Down Expand Up @@ -226,7 +226,7 @@ contract GenericLogic {
* @param totalDebtInBaseCurrency The total borrow balance in the base currency used by the price feed
* @param ltv The average loan to value
* @return The amount available to borrow in the base currency of the used by the price feed
**/
*/
function calculateAvailableBorrows(
uint256 totalCollateralInBaseCurrency,
uint256 totalDebtInBaseCurrency,
Expand Down
2 changes: 1 addition & 1 deletion Certora/certora/harness/PoolConfiguratorHarness.sol
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {IPoolDataProvider} from '../../contracts/interfaces/IPoolDataProvider.so
* @title PoolConfigurator
* @author Aave
* @dev Implements the configuration methods for the Aave protocol
**/
*/
contract PoolConfiguratorHarness is VersionedInitializable, IPoolConfigurator {
using PercentageMath for uint256;
using ReserveConfiguration for DataTypes.ReserveConfigurationMap;
Expand Down
4 changes: 2 additions & 2 deletions Certora/certora/harness/PoolHarnessForConfigurator.sol
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import {Helpers} from '../../contracts/protocol/libraries/helpers/Helpers.sol';
* @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
**/
*/
contract PoolHarnessForConfigurator is VersionedInitializable, IPool, PoolStorage {
using WadRayMath for uint256;
using ReserveLogic for DataTypes.ReserveData;
Expand Down Expand Up @@ -88,7 +88,7 @@ contract PoolHarnessForConfigurator is VersionedInitializable, IPool, PoolStorag
* PoolAddressesProvider of the market.
* @dev Caching the address of the PoolAddressesProvider in order to reduce gas consumption on subsequent operations
* @param provider The address of the PoolAddressesProvider
**/
*/
function initialize(IPoolAddressesProvider provider) external initializer {
require(provider == _addressesProvider, Errors.PC_INVALID_CONFIGURATION);
_maxStableRateBorrowSizePercent = 2500;
Expand Down
2 changes: 1 addition & 1 deletion Certora/certora/harness/StableDebtTokenHarness.sol
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ contract StableDebtTokenHarness is StableDebtToken {

/**
Simplification: The user accumulates no interest (the balance increase is always 0).
**/
*/
function balanceOf(address account) public view override returns (uint256) {
return IncentivizedERC20.balanceOf(account);
}
Expand Down
2 changes: 1 addition & 1 deletion contracts/flashloan/interfaces/IFlashLoanReceiver.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {IPool} from '../../interfaces/IPool.sol';
* @author Aave
* @notice Defines the basic interface of a flashloan-receiver contract.
* @dev Implement this interface to develop a flashloan-compatible flashLoanReceiver contract
**/
*/
interface IFlashLoanReceiver {
/**
* @notice Executes an operation after receiving the flash-borrowed assets
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {IPool} from '../../interfaces/IPool.sol';
* @author Aave
* @notice Defines the basic interface of a flashloan-receiver contract.
* @dev Implement this interface to develop a flashloan-compatible flashLoanReceiver contract
**/
*/
interface IFlashLoanSimpleReceiver {
/**
* @notice Executes an operation after receiving the flash-borrowed asset
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IACLManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {IPoolAddressesProvider} from './IPoolAddressesProvider.sol';
* @title IACLManager
* @author Aave
* @notice Defines the basic interface for the ACL Manager
**/
*/
interface IACLManager {
/**
* @notice Returns the contract address of the PoolAddressesProvider
Expand Down
18 changes: 9 additions & 9 deletions contracts/interfaces/IAToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import {IInitializableAToken} from './IInitializableAToken.sol';
* @title IAToken
* @author Aave
* @notice Defines the basic interface for an AToken.
**/
*/
interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
/**
* @dev Emitted during the transfer action
* @param from The user whose tokens are being transferred
* @param to The recipient
* @param value The scaled amount being transferred
* @param index The next liquidity index of the reserve
**/
*/
event BalanceTransfer(address indexed from, address indexed to, uint256 value, uint256 index);

/**
Expand All @@ -43,7 +43,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
* @param receiverOfUnderlying The address that will receive the underlying
* @param amount The amount being burned
* @param index The next liquidity index of the reserve
**/
*/
function burn(
address from,
address receiverOfUnderlying,
Expand All @@ -63,7 +63,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
* @param from The address getting liquidated, current owner of the aTokens
* @param to The recipient
* @param value The amount of tokens getting transferred
**/
*/
function transferOnLiquidation(
address from,
address to,
Expand All @@ -75,7 +75,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
* @dev Used by the Pool to transfer assets in borrow(), withdraw() and flashLoan()
* @param user The recipient of the underlying
* @param amount The amount getting transferred
**/
*/
function transferUnderlyingTo(address user, uint256 amount) external;

/**
Expand All @@ -86,7 +86,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
* @param user The user executing the repayment
* @param onBehalfOf The address of the user who will get his debt reduced/removed
* @param amount The amount getting repaid
**/
*/
function handleRepayment(
address user,
address onBehalfOf,
Expand Down Expand Up @@ -118,13 +118,13 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
/**
* @notice Returns the address of the underlying asset of this aToken (E.g. WETH for aWETH)
* @return The address of the underlying asset
**/
*/
function UNDERLYING_ASSET_ADDRESS() external view returns (address);

/**
* @notice Returns the address of the Aave treasury, receiving the fees on this aToken.
* @return Address of the Aave treasury
**/
*/
function RESERVE_TREASURY_ADDRESS() external view returns (address);

/**
Expand All @@ -138,7 +138,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
* @notice Returns the nonce for owner.
* @param owner The address of the owner
* @return The nonce of the owner
**/
*/
function nonces(address owner) external view returns (uint256);

/**
Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/IAaveIncentivesController.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ pragma solidity ^0.8.0;
* @author Aave
* @notice Defines the basic interface for an Aave Incentives Controller.
* @dev It only contains one single function, needed as a hook on aToken and debtToken transfers.
**/
*/
interface IAaveIncentivesController {
/**
* @dev Called by the corresponding asset on transfer hook in order to update the rewards distribution.
* @dev The units of `totalSupply` and `userBalance` should be the same.
* @param user The address of the user whose asset balance has changed
* @param totalSupply The total supply of the asset prior to user balance change
* @param userBalance The previous user balance prior to balance change
**/
*/
function handleAction(
address user,
uint256 totalSupply,
Expand Down
6 changes: 3 additions & 3 deletions contracts/interfaces/ICreditDelegationToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pragma solidity ^0.8.0;
* @title ICreditDelegationToken
* @author Aave
* @notice Defines the basic interface for a token supporting credit delegation.
**/
*/
interface ICreditDelegationToken {
/**
* @dev Emitted on `approveDelegation` and `borrowAllowance
Expand All @@ -27,15 +27,15 @@ interface ICreditDelegationToken {
* delegatee cannot force a delegator HF to go below 1)
* @param delegatee The address receiving the delegated borrowing power
* @param amount The maximum amount being delegated.
**/
*/
function approveDelegation(address delegatee, uint256 amount) external;

/**
* @notice Returns the borrow allowance of the user
* @param fromUser The user to giving allowance
* @param toUser The user to give allowance to
* @return The current allowance of `toUser`
**/
*/
function borrowAllowance(address fromUser, address toUser) external view returns (uint256);

/**
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IDelegationToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pragma solidity ^0.8.0;
* @title IDelegationToken
* @author Aave
* @notice Implements an interface for tokens with delegation COMP/UNI compatible
**/
*/
interface IDelegationToken {
/**
* @notice Delegate voting power to a delegatee
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IERC20WithPermit.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {IERC20} from '../dependencies/openzeppelin/contracts/IERC20.sol';
* @title IERC20WithPermit
* @author Aave
* @notice Interface for the permit function (EIP-2612)
**/
*/
interface IERC20WithPermit is IERC20 {
/**
* @notice Allow passing a signed message to approve spending
Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/IInitializableAToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {IPool} from './IPool.sol';
* @title IInitializableAToken
* @author Aave
* @notice Interface for the initialize function on AToken
**/
*/
interface IInitializableAToken {
/**
* @dev Emitted when an aToken is initialized
Expand All @@ -20,7 +20,7 @@ interface IInitializableAToken {
* @param aTokenName The name of the aToken
* @param aTokenSymbol The symbol of the aToken
* @param params A set of encoded parameters for additional initialization
**/
*/
event Initialized(
address indexed underlyingAsset,
address indexed pool,
Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/IInitializableDebtToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {IPool} from './IPool.sol';
* @title IInitializableDebtToken
* @author Aave
* @notice Interface for the initialize function common between debt tokens
**/
*/
interface IInitializableDebtToken {
/**
* @dev Emitted when a debt token is initialized
Expand All @@ -19,7 +19,7 @@ interface IInitializableDebtToken {
* @param debtTokenName The name of the debt token
* @param debtTokenSymbol The symbol of the debt token
* @param params A set of encoded parameters for additional initialization
**/
*/
event Initialized(
address indexed underlyingAsset,
address indexed pool,
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IL2Pool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pragma solidity ^0.8.0;
* @title IL2Pool
* @author Aave
* @notice Defines the basic extension interface for an L2 Aave Pool.
**/
*/
interface IL2Pool {
/**
* @notice Calldata efficient wrapper of the supply function on behalf of the caller
Expand Down
Loading

0 comments on commit 32f0e72

Please sign in to comment.