Add missing doc comments

6 files changed, 55 insertions, 2 deletions

diff --git a/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts
index 821d1a8a2..d60d4339b 100644
--- a/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts
@@ -16,6 +16,14 @@ export class ERC20ProxyWrapper extends ContractWrapper {
     public abi: ContractAbi = artifacts.ERC20Proxy.compilerOutput.abi;
     private _erc20ProxyContractIfExists?: ERC20ProxyContract;
     private _contractAddressIfExists?: string;
+    /**
+     * Instantiate ERC20ProxyWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.erc20Proxy).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param contractAddressIfExists The contract address to use. This is usually pulled from
+     * the artifacts but needs to be specified when using with your own custom testnet.
+     */
     constructor(web3Wrapper: Web3Wrapper, networkId: number, contractAddressIfExists?: string) {
         super(web3Wrapper, networkId);
         this._contractAddressIfExists = contractAddressIfExists;
diff --git a/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
index 17bda5085..7ff0ee72e 100644
--- a/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
@@ -34,6 +34,14 @@ export class ERC20TokenWrapper extends ContractWrapper {
     public UNLIMITED_ALLOWANCE_IN_BASE_UNITS = constants.UNLIMITED_ALLOWANCE_IN_BASE_UNITS;
     private _tokenContractsByAddress: { [address: string]: ERC20TokenContract };
     private _erc20ProxyWrapper: ERC20ProxyWrapper;
+    /**
+     * Instantiate ERC20TokenWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.erc20Token).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param erc20ProxyWrapper The ERC20ProxyWrapper instance to use
+     * @param blockPollingIntervalMs The block polling interval to use for active subscriptions
+     */
     constructor(
         web3Wrapper: Web3Wrapper,
         networkId: number,
diff --git a/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts
index 38ecd4687..c17905cb7 100644
--- a/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts
@@ -16,6 +16,14 @@ export class ERC721ProxyWrapper extends ContractWrapper {
     public abi: ContractAbi = artifacts.ERC20Proxy.compilerOutput.abi;
     private _erc721ProxyContractIfExists?: ERC721ProxyContract;
     private _contractAddressIfExists?: string;
+    /**
+     * Instantiate ERC721ProxyWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.erc721Proxy).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param contractAddressIfExists The contract address to use. This is usually pulled from
+     * the artifacts but needs to be specified when using with your own custom testnet.
+     */
     constructor(web3Wrapper: Web3Wrapper, networkId: number, contractAddressIfExists?: string) {
         super(web3Wrapper, networkId);
         this._contractAddressIfExists = contractAddressIfExists;
diff --git a/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts
index 7231e0bde..6e0eede70 100644
--- a/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts
@@ -33,6 +33,14 @@ export class ERC721TokenWrapper extends ContractWrapper {
     public abi: ContractAbi = artifacts.ERC721Token.compilerOutput.abi;
     private _tokenContractsByAddress: { [address: string]: ERC721TokenContract };
     private _erc721ProxyWrapper: ERC721ProxyWrapper;
+    /**
+     * Instantiate ERC721TokenWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.erc721Token).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param erc721ProxyWrapper The ERC721ProxyWrapper instance to use
+     * @param blockPollingIntervalMs The block polling interval to use for active subscriptions
+     */
     constructor(
         web3Wrapper: Web3Wrapper,
         networkId: number,
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,
diff --git a/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts
index 3e7619228..5beb35a27 100644
--- a/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts
@@ -34,6 +34,17 @@ export class ExchangeWrapper extends ContractWrapper {
     private _exchangeContractIfExists?: ExchangeContract;
     private _contractAddressIfExists?: string;
     private _zrxContractAddressIfExists?: string;
+    /**
+     * Instantiate ExchangeWrapper. We recommend you don't instantiate this yourself, rather
+     * use it through the ContractWrappers class property (contractWrappers.exchange).
+     * @param web3Wrapper Web3Wrapper instance to use
+     * @param networkId Desired networkId
+     * @param contractAddressIfExists The exchange contract address to use. This is usually pulled from
+     * the artifacts but needs to be specified when using with your own custom testnet.
+     * @param zrxContractAddressIfExists The ZRXToken contract address to use. This is usually pulled from
+     * the artifacts but needs to be specified when using with your own custom testnet.
+     * @param blockPollingIntervalMs The block polling interval to use for active subscriptions
+     */
     constructor(
         web3Wrapper: Web3Wrapper,
         networkId: number,
@@ -626,7 +637,7 @@ export class ExchangeWrapper extends ContractWrapper {
     }
     /**
      * Batch version of cancelOrderAsync. Executes multiple cancels atomically in a single transaction.
-     * @param   orders                An array of orders to cancel.
+     * @param   orders                An array of orders to cancel.Optional arguments this method accepts.
      * @param   orderTransactionOpts  Optional arguments this method accepts.
      * @return  Transaction hash.
      */
@@ -665,6 +676,7 @@ export class ExchangeWrapper extends ContractWrapper {
      * @param leftSignedOrder  First order to match.
      * @param rightSignedOrder Second order to match.
      * @param takerAddress     The address that sends the transaction and gets the spread.
+     * @param orderTransactionOpts Optional arguments this method accepts.
      * @return Transaction hash.
      */
     @decorators.asyncZeroExErrorHandler
@@ -723,6 +735,7 @@ export class ExchangeWrapper extends ContractWrapper {
      * @param signerAddress Address that should have signed the given hash.
      * @param signature     Proof that the hash has been signed by signer.
      * @param senderAddress Address that should send the transaction.
+     * @param orderTransactionOpts Optional arguments this method accepts.
      * @returns Transaction hash.
      */
     @decorators.asyncZeroExErrorHandler
@@ -881,7 +894,7 @@ export class ExchangeWrapper extends ContractWrapper {
     /**
      * Cancel a given order.
      * @param   order           An object that conforms to the Order or SignedOrder interface. The order you would like to cancel.
-     * @param   transactionOpts Optional arguments this method accepts.
+     * @param   orderTransactionOpts Optional arguments this method accepts.
      * @return  Transaction hash.
      */
     @decorators.asyncZeroExErrorHandler