aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-04 04:36:44 +0800
committerFabio Berger <me@fabioberger.com>2018-08-04 04:36:44 +0800
commitc68e1839535e0eeb7c66e8712d1ce786d0f964df (patch)
tree3d9728dbf45d88552b121e07b3b4c9e427a509f5
parentf42119c9286ad70504b6f8395bcdd801a1ac52c3 (diff)
downloaddexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar.gz
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar.bz2
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar.lz
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar.xz
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.tar.zst
dexon-sol-tools-c68e1839535e0eeb7c66e8712d1ce786d0f964df.zip
Add missing sol-cov comments
-rw-r--r--packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts5
-rw-r--r--packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts5
-rw-r--r--packages/sol-cov/src/trace_collection_subprovider.ts2
3 files changed, 11 insertions, 1 deletions
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;
diff --git a/packages/sol-cov/src/trace_collection_subprovider.ts b/packages/sol-cov/src/trace_collection_subprovider.ts
index 5a101dfeb..91c21fe94 100644
--- a/packages/sol-cov/src/trace_collection_subprovider.ts
+++ b/packages/sol-cov/src/trace_collection_subprovider.ts
@@ -63,7 +63,7 @@ export abstract class TraceCollectionSubprovider extends Subprovider {
* turn to handle a JSON RPC request.
* @param payload JSON RPC payload
* @param next Callback to call if this subprovider decides not to handle the request
- * @param end Callback to call if subprovider handled the request and wants to pass back the request.
+ * @param _end Callback to call if subprovider handled the request and wants to pass back the request.
*/
// tslint:disable-next-line:prefer-function-over-method async-suffix
public async handleRequest(payload: JSONRPCRequestPayload, next: NextCallback, _end: ErrorCallback): Promise<void> {