update solidoc config, contracts docs and README

Author: tjcloa

README.md

@@ -651,6 +651,207 @@ Before run this command, make sure that we have:
 - The solc version 0.5.17 installed.
 We can use [`solc-select`](https://github.com/crytic/solc-select) for managing the solc version.
 
+[comment]: #solidoc (Start)
+### Contracts
+
+* [Address](docs/Address.md)
+* [Administered](docs/Administered.md)
+* [AdminRole](docs/AdminRole.md)
+* [AdvancedToken](docs/AdvancedToken.md)
+* [AdvancedTokenStorage](docs/AdvancedTokenStorage.md)
+* [Affiliates](docs/Affiliates.md)
+* [AffiliatesEvents](docs/AffiliatesEvents.md)
+* [ApprovalReceiver](docs/ApprovalReceiver.md)
+* [BProPriceFeed](docs/BProPriceFeed.md)
+* [CheckpointsShared](docs/CheckpointsShared.md)
+* [Constants](docs/Constants.md)
+* [Context](docs/Context.md)
+* [DevelopmentFund](docs/DevelopmentFund.md)
+* [DummyContract](docs/DummyContract.md)
+* [EnumerableAddressSet](docs/EnumerableAddressSet.md)
+* [EnumerableBytes32Set](docs/EnumerableBytes32Set.md)
+* [EnumerableBytes4Set](docs/EnumerableBytes4Set.md)
+* [ERC20](docs/ERC20.md)
+* [ERC20Detailed](docs/ERC20Detailed.md)
+* [ErrorDecoder](docs/ErrorDecoder.md)
+* [Escrow](docs/Escrow.md)
+* [EscrowReward](docs/EscrowReward.md)
+* [FeedsLike](docs/FeedsLike.md)
+* [FeesEvents](docs/FeesEvents.md)
+* [FeeSharingCollector](docs/FeeSharingCollector.md)
+* [FeeSharingCollectorProxy](docs/FeeSharingCollectorProxy.md)
+* [FeeSharingCollectorStorage](docs/FeeSharingCollectorStorage.md)
+* [FeesHelper](docs/FeesHelper.md)
+* [FourYearVesting](docs/FourYearVesting.md)
+* [FourYearVestingFactory](docs/FourYearVestingFactory.md)
+* [FourYearVestingLogic](docs/FourYearVestingLogic.md)
+* [FourYearVestingStorage](docs/FourYearVestingStorage.md)
+* [GenericTokenSender](docs/GenericTokenSender.md)
+* [GovernorAlpha](docs/GovernorAlpha.md)
+* [GovernorVault](docs/GovernorVault.md)
+* [IApproveAndCall](docs/IApproveAndCall.md)
+* [IChai](docs/IChai.md)
+* [IContractRegistry](docs/IContractRegistry.md)
+* [IConverterAMM](docs/IConverterAMM.md)
+* [IERC1820Registry](docs/IERC1820Registry.md)
+* [IERC20_](docs/IERC20_.md)
+* [IERC20](docs/IERC20.md)
+* [IERC777](docs/IERC777.md)
+* [IERC777Recipient](docs/IERC777Recipient.md)
+* [IERC777Sender](docs/IERC777Sender.md)
+* [IFeeSharingCollector](docs/IFeeSharingCollector.md)
+* [IFourYearVesting](docs/IFourYearVesting.md)
+* [IFourYearVestingFactory](docs/IFourYearVestingFactory.md)
+* [IFunctionsList](docs/IFunctionsList.md)
+* [ILiquidityMining](docs/ILiquidityMining.md)
+* [ILiquidityPoolV1Converter](docs/ILiquidityPoolV1Converter.md)
+* [ILoanPool](docs/ILoanPool.md)
+* [ILoanToken](docs/ILoanToken.md)
+* [ILoanTokenLogicBeacon](docs/ILoanTokenLogicBeacon.md)
+* [ILoanTokenLogicModules](docs/ILoanTokenLogicModules.md)
+* [ILoanTokenLogicProxy](docs/ILoanTokenLogicProxy.md)
+* [ILoanTokenModules](docs/ILoanTokenModules.md)
+* [ILoanTokenWRBTC](docs/ILoanTokenWRBTC.md)
+* [ILockedSOV](docs/ILockedSOV.md)
+* [IMoCState](docs/IMoCState.md)
+* [IModulesProxyRegistry](docs/IModulesProxyRegistry.md)
+* [Initializable](docs/Initializable.md)
+* [InterestUser](docs/InterestUser.md)
+* [IPot](docs/IPot.md)
+* [IPriceFeeds](docs/IPriceFeeds.md)
+* [IPriceFeedsExt](docs/IPriceFeedsExt.md)
+* [IProtocol](docs/IProtocol.md)
+* [IRSKOracle](docs/IRSKOracle.md)
+* [ISovryn](docs/ISovryn.md)
+* [ISovrynSwapNetwork](docs/ISovrynSwapNetwork.md)
+* [IStaking](docs/IStaking.md)
+* [ISwapsImpl](docs/ISwapsImpl.md)
+* [ITeamVesting](docs/ITeamVesting.md)
+* [ITimelock](docs/ITimelock.md)
+* [IV1PoolOracle](docs/IV1PoolOracle.md)
+* [IVesting](docs/IVesting.md)
+* [IVestingFactory](docs/IVestingFactory.md)
+* [IVestingRegistry](docs/IVestingRegistry.md)
+* [IWrbtc](docs/IWrbtc.md)
+* [IWrbtcERC20](docs/IWrbtcERC20.md)
+* [LenderInterestStruct](docs/LenderInterestStruct.md)
+* [LiquidationHelper](docs/LiquidationHelper.md)
+* [LiquidityMining](docs/LiquidityMining.md)
+* [LiquidityMiningConfigToken](docs/LiquidityMiningConfigToken.md)
+* [LiquidityMiningProxy](docs/LiquidityMiningProxy.md)
+* [LiquidityMiningStorage](docs/LiquidityMiningStorage.md)
+* [LoanClosingsEvents](docs/LoanClosingsEvents.md)
+* [LoanClosingsLiquidation](docs/LoanClosingsLiquidation.md)
+* [LoanClosingsRollover](docs/LoanClosingsRollover.md)
+* [LoanClosingsShared](docs/LoanClosingsShared.md)
+* [LoanClosingsWith](docs/LoanClosingsWith.md)
+* [LoanClosingsWithoutInvariantCheck](docs/LoanClosingsWithoutInvariantCheck.md)
+* [LoanInterestStruct](docs/LoanInterestStruct.md)
+* [LoanMaintenance](docs/LoanMaintenance.md)
+* [LoanMaintenanceEvents](docs/LoanMaintenanceEvents.md)
+* [LoanOpenings](docs/LoanOpenings.md)
+* [LoanOpeningsEvents](docs/LoanOpeningsEvents.md)
+* [LoanParamsStruct](docs/LoanParamsStruct.md)
+* [LoanSettings](docs/LoanSettings.md)
+* [LoanSettingsEvents](docs/LoanSettingsEvents.md)
+* [LoanStruct](docs/LoanStruct.md)
+* [LoanToken](docs/LoanToken.md)
+* [LoanTokenBase](docs/LoanTokenBase.md)
+* [LoanTokenLogicBeacon](docs/LoanTokenLogicBeacon.md)
+* [LoanTokenLogicLM](docs/LoanTokenLogicLM.md)
+* [LoanTokenLogicProxy](docs/LoanTokenLogicProxy.md)
+* [LoanTokenLogicStandard](docs/LoanTokenLogicStandard.md)
+* [LoanTokenLogicStorage](docs/LoanTokenLogicStorage.md)
+* [LoanTokenLogicWrbtc](docs/LoanTokenLogicWrbtc.md)
+* [LoanTokenSettingsLowerAdmin](docs/LoanTokenSettingsLowerAdmin.md)
+* [LockedSOV](docs/LockedSOV.md)
+* [MarginTradeStructHelpers](docs/MarginTradeStructHelpers.md)
+* [Medianizer](docs/Medianizer.md)
+* [ModuleCommonFunctionalities](docs/ModuleCommonFunctionalities.md)
+* [ModulesCommonEvents](docs/ModulesCommonEvents.md)
+* [ModulesProxy](docs/ModulesProxy.md)
+* [ModulesProxyRegistry](docs/ModulesProxyRegistry.md)
+* [MultiSigKeyHolders](docs/MultiSigKeyHolders.md)
+* [MultiSigWallet](docs/MultiSigWallet.md)
+* [Mutex](docs/Mutex.md)
+* [Objects](docs/Objects.md)
+* [OrderStruct](docs/OrderStruct.md)
+* [OrigingVestingCreator](docs/OrigingVestingCreator.md)
+* [OriginInvestorsClaim](docs/OriginInvestorsClaim.md)
+* [Ownable](docs/Ownable.md)
+* [Pausable](docs/Pausable.md)
+* [PausableOz](docs/PausableOz.md)
+* [PreviousLoanToken](docs/PreviousLoanToken.md)
+* [PreviousLoanTokenSettingsLowerAdmin](docs/PreviousLoanTokenSettingsLowerAdmin.md)
+* [PriceFeedRSKOracle](docs/PriceFeedRSKOracle.md)
+* [PriceFeeds](docs/PriceFeeds.md)
+* [PriceFeedsLocal](docs/PriceFeedsLocal.md)
+* [PriceFeedsMoC](docs/PriceFeedsMoC.md)
+* [PriceFeedV1PoolOracle](docs/PriceFeedV1PoolOracle.md)
+* [ProtocolAffiliatesInterface](docs/ProtocolAffiliatesInterface.md)
+* [ProtocolLike](docs/ProtocolLike.md)
+* [ProtocolSettings](docs/ProtocolSettings.md)
+* [ProtocolSettingsEvents](docs/ProtocolSettingsEvents.md)
+* [ProtocolSettingsLike](docs/ProtocolSettingsLike.md)
+* [ProtocolSwapExternalInterface](docs/ProtocolSwapExternalInterface.md)
+* [ProtocolTokenUser](docs/ProtocolTokenUser.md)
+* [Proxy](docs/Proxy.md)
+* [ProxyOwnable](docs/ProxyOwnable.md)
+* [ReentrancyGuard](docs/ReentrancyGuard.md)
+* [RewardHelper](docs/RewardHelper.md)
+* [RSKAddrValidator](docs/RSKAddrValidator.md)
+* [SafeERC20](docs/SafeERC20.md)
+* [SafeMath](docs/SafeMath.md)
+* [SafeMath96](docs/SafeMath96.md)
+* [setGet](docs/setGet.md)
+* [SharedReentrancyGuard](docs/SharedReentrancyGuard.md)
+* [SignedSafeMath](docs/SignedSafeMath.md)
+* [SOV](docs/SOV.md)
+* [sovrynProtocol](docs/sovrynProtocol.md)
+* [StakingAdminModule](docs/StakingAdminModule.md)
+* [StakingGovernanceModule](docs/StakingGovernanceModule.md)
+* [StakingInterface](docs/StakingInterface.md)
+* [StakingProxy](docs/StakingProxy.md)
+* [StakingRewards](docs/StakingRewards.md)
+* [StakingRewardsProxy](docs/StakingRewardsProxy.md)
+* [StakingRewardsStorage](docs/StakingRewardsStorage.md)
+* [StakingShared](docs/StakingShared.md)
+* [StakingStakeModule](docs/StakingStakeModule.md)
+* [StakingStorageModule](docs/StakingStorageModule.md)
+* [StakingStorageShared](docs/StakingStorageShared.md)
+* [StakingVestingModule](docs/StakingVestingModule.md)
+* [StakingWithdrawModule](docs/StakingWithdrawModule.md)
+* [State](docs/State.md)
+* [SwapsEvents](docs/SwapsEvents.md)
+* [SwapsExternal](docs/SwapsExternal.md)
+* [SwapsImplLocal](docs/SwapsImplLocal.md)
+* [SwapsImplSovrynSwap](docs/SwapsImplSovrynSwap.md)
+* [SwapsUser](docs/SwapsUser.md)
+* [TeamVesting](docs/TeamVesting.md)
+* [Timelock](docs/Timelock.md)
+* [TimelockHarness](docs/TimelockHarness.md)
+* [TimelockInterface](docs/TimelockInterface.md)
+* [TokenSender](docs/TokenSender.md)
+* [UpgradableProxy](docs/UpgradableProxy.md)
+* [USDTPriceFeed](docs/USDTPriceFeed.md)
+* [Utils](docs/Utils.md)
+* [VaultController](docs/VaultController.md)
+* [Vesting](docs/Vesting.md)
+* [VestingCreator](docs/VestingCreator.md)
+* [VestingFactory](docs/VestingFactory.md)
+* [VestingLogic](docs/VestingLogic.md)
+* [VestingRegistry](docs/VestingRegistry.md)
+* [VestingRegistry2](docs/VestingRegistry2.md)
+* [VestingRegistry3](docs/VestingRegistry3.md)
+* [VestingRegistryLogic](docs/VestingRegistryLogic.md)
+* [VestingRegistryProxy](docs/VestingRegistryProxy.md)
+* [VestingRegistryStorage](docs/VestingRegistryStorage.md)
+* [VestingStorage](docs/VestingStorage.md)
+* [WeightedStakingModule](docs/WeightedStakingModule.md)
+* [WRBTC](docs/WRBTC.md)
+
+[comment]: #solidoc (End)
+
 
 ## Contributing
 

docs/Address.md

@@ -2,7 +2,7 @@
 
 View Source: [contracts/openzeppelin/Address.sol](../contracts/openzeppelin/Address.sol)
 
-**Address**
+## **Address** contract
 
 Collection of functions related to the address type
 
@@ -147,7 +147,6 @@ function sendValue(address recipient, uint256 amount) internal {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/AdminRole.md

@@ -5,7 +5,7 @@ View Source: [contracts/utils/AdminRole.sol](../contracts/utils/AdminRole.sol)
 **↗ Extends: [Ownable](Ownable.md)**
 **↘ Derived Contracts: [GenericTokenSender](GenericTokenSender.md), [LiquidityMiningStorage](LiquidityMiningStorage.md), [VestingCreator](VestingCreator.md), [VestingRegistryStorage](VestingRegistryStorage.md)**
 
-**AdminRole**
+## **AdminRole** contract
 
 ## Contract Members
 **Constants & Variables**
@@ -110,7 +110,6 @@ function removeAdmin(address _admin) public onlyOwner {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/Administered.md

@@ -4,7 +4,7 @@ View Source: [contracts/mockup/TimelockHarness.sol](../contracts/mockup/Timelock
 
 **↗ Extends: [Timelock](Timelock.md)**
 
-**Administered**
+## **Administered** contract
 
 ## Functions
 
@@ -221,7 +221,6 @@ function harnessAcceptAdmin(Administered administered) public {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/AdvancedToken.md

@@ -5,7 +5,7 @@ View Source: [contracts/connectors/loantoken/AdvancedToken.sol](../contracts/con
 **↗ Extends: [AdvancedTokenStorage](AdvancedTokenStorage.md)**
 **↘ Derived Contracts: [LoanTokenLogicStorage](LoanTokenLogicStorage.md)**
 
-**AdvancedToken**
+## **AdvancedToken** contract
 
 This contract code comes from bZx. bZx is a protocol for tokenized margin
 trading and lending https://bzx.network similar to the dYdX protocol.
@@ -183,7 +183,6 @@ function _burn(
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/AdvancedTokenStorage.md

@@ -5,7 +5,7 @@ View Source: [contracts/connectors/loantoken/AdvancedTokenStorage.sol](../contra
 **↗ Extends: [LoanTokenBase](LoanTokenBase.md)**
 **↘ Derived Contracts: [AdvancedToken](AdvancedToken.md), [ILoanTokenLogicBeacon](ILoanTokenLogicBeacon.md), [LoanToken](LoanToken.md), [LoanTokenLogicProxy](LoanTokenLogicProxy.md), [PreviousLoanToken](PreviousLoanToken.md), [PreviousLoanTokenSettingsLowerAdmin](PreviousLoanTokenSettingsLowerAdmin.md)**
 
-**AdvancedTokenStorage**
+## **AdvancedTokenStorage** contract
 
 This contract code comes from bZx. bZx is a protocol for tokenized
 margin trading and lending https://bzx.network similar to the dYdX protocol.
@@ -143,7 +143,6 @@ function allowance(address _owner, address _spender) public view returns (uint25
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/Affiliates.md

@@ -4,7 +4,7 @@ View Source: [contracts/modules/Affiliates.sol](../contracts/modules/Affiliates.
 
 **↗ Extends: [State](State.md), [AffiliatesEvents](AffiliatesEvents.md), [ModuleCommonFunctionalities](ModuleCommonFunctionalities.md)**
 
-**Affiliates**
+## **Affiliates** contract
 
 Track referrals and reward referrers (affiliates) with tokens.
   In-detail specifications are found at https://wiki.sovryn.app/en/community/Affiliates
@@ -944,7 +944,6 @@ nction getAffiliateRewardsHeld(address referrer) public view returns (uint256) {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/AffiliatesEvents.md

@@ -5,7 +5,7 @@ View Source: [contracts/events/AffiliatesEvents.sol](../contracts/events/Affilia
 **↗ Extends: [ModulesCommonEvents](ModulesCommonEvents.md)**
 **↘ Derived Contracts: [Affiliates](Affiliates.md), [ISovryn](ISovryn.md)**
 
-**AffiliatesEvents**
+## **AffiliatesEvents** contract
 
 **Events**
 
@@ -36,7 +36,6 @@ event WithdrawAffiliatesReferrerTokenFees(address indexed referrer, address inde
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/ApprovalReceiver.md

@@ -5,7 +5,7 @@ View Source: [contracts/governance/ApprovalReceiver.sol](../contracts/governance
 **↗ Extends: [ErrorDecoder](ErrorDecoder.md), [IApproveAndCall](IApproveAndCall.md)**
 **↘ Derived Contracts: [FourYearVestingLogic](FourYearVestingLogic.md), [StakingStakeModule](StakingStakeModule.md), [VestingLogic](VestingLogic.md)**
 
-**ApprovalReceiver**
+## **ApprovalReceiver** contract
 
 ## Modifiers
 
@@ -215,7 +215,6 @@ function _getSig(bytes memory _data) internal pure returns (bytes4 sig) {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)

docs/BProPriceFeed.md

@@ -6,7 +6,7 @@ View Source: [contracts/feeds/BProPriceFeed.sol](../contracts/feeds/BProPriceFee
 
 **↗ Extends: [IPriceFeedsExt](IPriceFeedsExt.md), [Ownable](Ownable.md)**
 
-**BProPriceFeed**
+## **BProPriceFeed** contract
 
 ## Contract Members
 **Constants & Variables**
@@ -60,7 +60,7 @@ constructor(address _mocStateAddress) public {
 
 > ### latestAnswer
 
-⤾ overrides [IPriceFeedsExt.latestAnswer](IPriceFeedsExt.md#latestanswer)
+undefined
 
 Get BPro USD price.
      *
@@ -149,7 +149,6 @@ function setMoCStateAddress(address _mocStateAddress) public onlyOwner {
 * [Context](Context.md)
 * [DevelopmentFund](DevelopmentFund.md)
 * [DummyContract](DummyContract.md)
-* [ECDSA](ECDSA.md)
 * [EnumerableAddressSet](EnumerableAddressSet.md)
 * [EnumerableBytes32Set](EnumerableBytes32Set.md)
 * [EnumerableBytes4Set](EnumerableBytes4Set.md)