diff options
author | Fabio Berger <me@fabioberger.com> | 2017-06-10 19:27:03 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-06-10 19:27:03 +0800 |
commit | 47e6fb31b8477501eed9aa38d3017589fb9bd242 (patch) | |
tree | ce1b2a418a9bb87a58e814567fa80adf37569fea /src/contract_wrappers/token_registry_wrapper.ts | |
parent | b739ae24944876c28a2ff474993e72a7178b3d1b (diff) | |
download | dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar.gz dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar.bz2 dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar.lz dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar.xz dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.tar.zst dexon-0x-contracts-47e6fb31b8477501eed9aa38d3017589fb9bd242.zip |
Add param & return comments to all public methods and add comments to some public methods that were missing them
Diffstat (limited to 'src/contract_wrappers/token_registry_wrapper.ts')
-rw-r--r-- | src/contract_wrappers/token_registry_wrapper.ts | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/contract_wrappers/token_registry_wrapper.ts b/src/contract_wrappers/token_registry_wrapper.ts index 86bea1c5d..5987dfca6 100644 --- a/src/contract_wrappers/token_registry_wrapper.ts +++ b/src/contract_wrappers/token_registry_wrapper.ts @@ -13,6 +13,10 @@ export class TokenRegistryWrapper extends ContractWrapper { public invalidateContractInstance(): void { delete this.tokenRegistryContractIfExists; } + /** + * Retrieves all the tokens currently listed in the Token Registry smart contract + * @return An array of JS objects that conform to the Token interface. + */ public async getTokensAsync(): Promise<Token[]> { const tokenRegistryContract = await this.getTokenRegistryContractAsync(); |