From 3ee3fc2fb35b5ecc8237363d6307b7135ed4f927 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Fri, 3 Aug 2018 17:13:10 +0200
Subject: Add missing doc comments

---
 .../src/contract_wrappers/ether_token_wrapper.ts                  | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts')

diff --git a/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts
index 5046d3667..d7b6effd8 100644
--- a/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts
@@ -24,6 +24,14 @@ export class EtherTokenWrapper extends ContractWrapper {
         [address: string]: WETH9Contract;
     } = {};
     private _erc20TokenWrapper: ERC20TokenWrapper;
+    /**
+     * Instantiate EtherTokenWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.etherToken).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param erc20TokenWrapper The ERC20TokenWrapper instance to use
+     * @param blockPollingIntervalMs The block polling interval to use for active subscriptions
+     */
     constructor(
         web3Wrapper: Web3Wrapper,
         networkId: number,
-- 
cgit v1.2.3