From e31ba2e12e90cca10037d2f6bf8ae17fe42e1991 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 21 Mar 2018 18:06:50 +0100 Subject: Add missing param comments --- packages/deployer/src/utils/compiler.ts | 3 +++ 1 file changed, 3 insertions(+) (limited to 'packages') diff --git a/packages/deployer/src/utils/compiler.ts b/packages/deployer/src/utils/compiler.ts index d8b5f78c9..9c8fef26d 100644 --- a/packages/deployer/src/utils/compiler.ts +++ b/packages/deployer/src/utils/compiler.ts @@ -9,6 +9,7 @@ import { ContractArtifact, ContractSources } from './types'; /** * Gets contract data on network or returns if an artifact does not exist. + * @param artifactsDir Path to the artifacts directory. * @param fileName Name of contract file. * @return Contract data on network or undefined. */ @@ -34,6 +35,7 @@ export async function getContractArtifactIfExistsAsync( /** * Creates the artifacts directory if it does not already exist. + * @param artifactsDir Path to the artifacts directory. */ export async function createArtifactsDirIfDoesNotExistAsync(artifactsDir: string): Promise { if (!fsWrapper.doesPathExistSync(artifactsDir)) { @@ -104,6 +106,7 @@ export function parseDependencies(source: string): string[] { /** * Callback to resolve dependencies with `solc.compile`. * Throws error if contractSources not yet initialized. + * @param contractSources Source codes of contracts. * @param importPath Path to an imported dependency. * @return Import contents object containing source code of dependency. */ -- cgit v1.2.3