aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-doc
diff options
context:
space:
mode:
Diffstat (limited to 'packages/sol-doc')
-rw-r--r--packages/sol-doc/src/solidity_doc_generator.ts4
-rw-r--r--packages/sol-doc/test/solidity_doc_generator_test.ts2
-rw-r--r--packages/sol-doc/tsconfig.json3
3 files changed, 3 insertions, 6 deletions
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts
index 457c86c91..debee5b87 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -1,7 +1,6 @@
import * as _ from 'lodash';
import {
- AbiDefinition,
ConstructorAbi,
DataItem,
DevdocOutput,
@@ -22,7 +21,6 @@ import {
Type,
TypeDocTypes,
} from '@0xproject/types';
-import { logUtils } from '@0xproject/utils';
/**
* Invoke the Solidity compiler and transform its ABI and devdoc outputs into
@@ -122,7 +120,7 @@ function _genConstructorDoc(abiDefinition: ConstructorAbi, devdocIfExists: Devdo
let comment;
// TODO: use methodSignature as the key to abiEntry.devdoc.methods, and
// from that object extract the "details" (comment) property
- comment = 'something from devdoc';
+ comment = `something from devdoc, using ${methodSignature} to find it`;
const constructorDoc: SolidityMethod = {
isConstructor: true,
diff --git a/packages/sol-doc/test/solidity_doc_generator_test.ts b/packages/sol-doc/test/solidity_doc_generator_test.ts
index df6ad8e54..989f29320 100644
--- a/packages/sol-doc/test/solidity_doc_generator_test.ts
+++ b/packages/sol-doc/test/solidity_doc_generator_test.ts
@@ -3,8 +3,6 @@ import * as _ from 'lodash';
import * as chai from 'chai';
import 'mocha';
-import { DocSection } from '@0xproject/types';
-
import { generateSolDocAsync } from '../src/solidity_doc_generator';
import { chaiSetup } from './util/chai_setup';
diff --git a/packages/sol-doc/tsconfig.json b/packages/sol-doc/tsconfig.json
index e35816553..2ee711adc 100644
--- a/packages/sol-doc/tsconfig.json
+++ b/packages/sol-doc/tsconfig.json
@@ -1,7 +1,8 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
- "outDir": "lib"
+ "outDir": "lib",
+ "rootDir": "."
},
"include": ["./src/**/*", "./test/**/*"]
}