Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Commit d1922da

Browse files
committed
Added some javadocs.
1 parent cdf781e commit d1922da

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

contracts/core/interfaces/ICore.sol

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
pragma solidity 0.4.24;
1818

1919
/**
20-
* @title IVault
20+
* @title ICore
2121
* @author Set Protocol
2222
*
23-
* The IVault interface provides a light-weight, structured way to interact with the Vault
24-
* contract from another contract.
23+
* The ICore Contract defines all the functions exposed in the Core through its
24+
* various extensions and is a light weight way to interact with the contract.
2525
*/
2626

2727
interface ICore {
@@ -172,6 +172,13 @@ pragma solidity 0.4.24;
172172
public
173173
returns(address);
174174

175+
/**
176+
* Function to calculate the transfer value of a component given quantity of Set
177+
*
178+
* @param _componentUnits The units of the component token
179+
* @param _naturalUnit The natural unit of the Set token
180+
* @param _quantity The number of tokens being redeem
181+
*/
175182
function calculateTransferValue(
176183
uint _componentUnits,
177184
uint _naturalUnit,
@@ -180,4 +187,4 @@ pragma solidity 0.4.24;
180187
pure
181188
internal
182189
returns(uint);
183-
}
190+
}

0 commit comments

Comments
 (0)