aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-doc
diff options
context:
space:
mode:
authorF. Eugene Aumson <gene@aumson.org>2018-09-22 22:21:27 +0800
committerF. Eugene Aumson <gene@aumson.org>2018-09-22 22:21:27 +0800
commit37cb18e1daa8bf33b92b94b93851e91d50383c1e (patch)
treec81da15651832319d372a53a8f0c166a9ab45dbf /packages/sol-doc
parent3e5d427d4e873080f2a369db7f844cbadd610fcb (diff)
downloaddexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar.gz
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar.bz2
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar.lz
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar.xz
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.tar.zst
dexon-sol-tools-37cb18e1daa8bf33b92b94b93851e91d50383c1e.zip
fix: rename variable
Diffstat (limited to 'packages/sol-doc')
-rw-r--r--packages/sol-doc/src/solidity_doc_generator.ts6
1 files changed, 3 insertions, 3 deletions
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts
index 78c56e7fa..2586cf91c 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -26,17 +26,17 @@ import {
/**
* Invoke the Solidity compiler and transform its ABI and devdoc outputs into
* the types that are used as input to documentation generation tools.
- * @param contractsToCompile list of contracts for which to generate doc objects
+ * @param contractsToDocument list of contracts for which to generate doc objects
* @param contractsDir the directory in which to find the `contractsToCompile` as well as their dependencies.
* @return doc object for use with documentation generation tools.
*/
export async function generateSolDocAsync(
contractsDir: string,
- contractsToCompile?: string[],
+ contractsToDocument?: string[],
): Promise<DocAgnosticFormat> {
const doc: DocAgnosticFormat = {};
- const compilerOptions = _makeCompilerOptions(contractsDir, contractsToCompile);
+ const compilerOptions = _makeCompilerOptions(contractsDir, contractsToDocument);
const compiler = new Compiler(compilerOptions);
const compilerOutputs = await compiler.getCompilerOutputsAsync();
for (const compilerOutput of compilerOutputs) {