From c68e1839535e0eeb7c66e8712d1ce786d0f964df Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 22:36:44 +0200 Subject: Add missing sol-cov comments --- .../sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts | 5 +++++ packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts | 5 +++++ 2 files changed, 10 insertions(+) (limited to 'packages/sol-cov/src/artifact_adapters') diff --git a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts index 8e03bf7fd..0601c5729 100644 --- a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts @@ -14,6 +14,11 @@ const CONFIG_FILE = 'compiler.json'; export class SolCompilerArtifactAdapter extends AbstractArtifactAdapter { private readonly _artifactsPath: string; private readonly _sourcesPath: string; + /** + * Instantiates a SolCompilerArtifactAdapter + * @param artifactsPath Path to your artifacts directory + * @param sourcesPath Path to your contract sources directory + */ constructor(artifactsPath?: string, sourcesPath?: string) { super(); const config: CompilerOptions = fs.existsSync(CONFIG_FILE) diff --git a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts index 53b77aed5..2f76f730a 100644 --- a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts @@ -9,6 +9,11 @@ import { SolCompilerArtifactAdapter } from './sol_compiler_artifact_adapter'; export class TruffleArtifactAdapter extends AbstractArtifactAdapter { private readonly _solcVersion: string; private readonly _sourcesPath: string; + /** + * Instantiates a TruffleArtifactAdapter + * @param artifactsPath Path to the truffle project's artifacts directory + * @param sourcesPath Path to the truffle project's contract sources directory + */ constructor(sourcesPath: string, solcVersion: string) { super(); this._solcVersion = solcVersion; -- cgit v1.2.3