aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-doc
diff options
context:
space:
mode:
authorF. Eugene Aumson <gene@aumson.org>2018-08-30 23:49:54 +0800
committerF. Eugene Aumson <gene@aumson.org>2018-08-31 00:02:42 +0800
commit297cbd996d7da0cb3232f47734290d0377693faf (patch)
tree3e2c7db09c0f3ed24ccccde854ff6f65eb22d039 /packages/sol-doc
parentf55234b4a04a3a26e6eda05a5c77a6bd984571ba (diff)
downloaddexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar.gz
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar.bz2
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar.lz
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar.xz
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.tar.zst
dexon-0x-contracts-297cbd996d7da0cb3232f47734290d0377693faf.zip
remove unnecessary class SolidityDocFormat
Diffstat (limited to 'packages/sol-doc')
-rw-r--r--packages/sol-doc/src/index.ts1
-rw-r--r--packages/sol-doc/src/solidity_doc_format.ts5
-rw-r--r--packages/sol-doc/src/solidity_doc_generator.ts7
3 files changed, 3 insertions, 10 deletions
diff --git a/packages/sol-doc/src/index.ts b/packages/sol-doc/src/index.ts
index f8f55c569..dc88fae90 100644
--- a/packages/sol-doc/src/index.ts
+++ b/packages/sol-doc/src/index.ts
@@ -1,2 +1 @@
export { SolidityDocGenerator } from './solidity_doc_generator';
-export { SolidityDocFormat } from './solidity_doc_format';
diff --git a/packages/sol-doc/src/solidity_doc_format.ts b/packages/sol-doc/src/solidity_doc_format.ts
deleted file mode 100644
index e980f59f6..000000000
--- a/packages/sol-doc/src/solidity_doc_format.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import { DocAgnosticFormat, DocSection } from '@0xproject/types';
-
-export class SolidityDocFormat implements DocAgnosticFormat {
- [sectionName: string]: DocSection;
-}
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts
index f6bbf52ba..aba7b5475 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -3,10 +3,9 @@ import * as _ from 'lodash';
import { MethodAbi } from 'ethereum-types';
import { Compiler, CompilerOptions } from '@0xproject/sol-compiler';
+import { DocAgnosticFormat } from '@0xproject/types';
import { logUtils } from '@0xproject/utils';
-import { SolidityDocFormat } from './solidity_doc_format';
-
/**
* Compiles solidity files to both their ABI and devdoc outputs, and transforms
* those outputs into the types that feed into documentation generation tools.
@@ -36,14 +35,14 @@ export class SolidityDocGenerator {
* @param contractsToCompile list of contracts for which to generate doc objects
* @return doc objects for use with documentation generation tools.
*/
- public async generateAsync(contractsToCompile: string[]): Promise<SolidityDocFormat> {
+ public async generateAsync(contractsToCompile: string[]): Promise<DocAgnosticFormat> {
if (!_.isUndefined(contractsToCompile)) {
this._compilerOptions.contracts = contractsToCompile;
}
const compiler = new Compiler(this._compilerOptions);
- const doc = new SolidityDocFormat();
+ const doc: DocAgnosticFormat = {};
const compilerOutputs = await compiler.getCompilerOutputsAsync();
for (const compilerOutput of compilerOutputs) {