remove unnecessary class SolidityDocFormat

This commit is contained in:
F. Eugene Aumson
2018-08-30 11:49:54 -04:00
parent f55234b4a0
commit 297cbd996d
3 changed files with 3 additions and 10 deletions

View File

@@ -1,2 +1 @@
export { SolidityDocGenerator } from './solidity_doc_generator';
export { SolidityDocFormat } from './solidity_doc_format';

View File

@@ -1,5 +0,0 @@
import { DocAgnosticFormat, DocSection } from '@0xproject/types';
export class SolidityDocFormat implements DocAgnosticFormat {
[sectionName: string]: DocSection;
}

View File

@@ -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) {