Extend documentation.

bancorprotocol · Jan 9, 2021 · fa66b06 · fa66b06
1 parent 3541d95
commit fa66b06
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/solidity/contracts/liquidity-protection/LiquidityProtectionStats.sol b/solidity/contracts/liquidity-protection/LiquidityProtectionStats.sol
@@ -91,20 +91,38 @@ contract LiquidityProtectionStats is ILiquidityProtectionStats, AccessControl, U
         totalProviderAmount[_poolToken][_reserveToken][_provider] = totalProviderAmount[_poolToken][_reserveToken][_provider].sub(_reserveAmount);
     }
 
+    /**
+     * @dev adds a pool to the list of pools of a liquidity provider
+     *
+     * @param _provider         liquidity provider address
+     * @param _poolToken        pool token address
+     */
     function addProviderPoolToken(
         address _provider,
         IDSToken _poolToken
     ) external override ownerOnly returns (bool) {
         return _providerPoolTokens[_provider].add(address(_poolToken));
     }
 
+    /**
+     * @dev removes a pool from the list of pools of a liquidity provider
+     *
+     * @param _provider         liquidity provider address
+     * @param _poolToken        pool token address
+     */
     function removeProviderPoolToken(
         address _provider,
         IDSToken _poolToken
     ) external override ownerOnly returns (bool) {
         return _providerPoolTokens[_provider].remove(address(_poolToken));
     }
 
+    /**
+     * @dev returns the list of pools of a liquidity provider
+     *
+     * @param _provider         liquidity provider address
+     * @return pool tokens
+     */
     function providerPoolTokens(
         address _provider
     ) external override view returns (IDSToken[] memory) {