crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: comments

Browse Source 
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219990314
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r220007992
https://github.com/0xProject/0x-monorepo/pull/1004
This commit is contained in:
F. Eugene Aumson
2018-09-25 15:32:52 -04:00
parent 7fbfd9ccd9
commit 2e7b218f40
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/sol-doc/src/solidity_doc_generator.ts
View File

@@ -27,8 +27,8 @@ import {
} from '@0xproject/types';
/**
* Invoke the Solidity compiler and transform its ABI and devdoc outputs into
* the types that are used as input to documentation generation tools.
* Invoke the Solidity compiler and transform its ABI and devdoc outputs into a
* JSON format easily consumed by documentation rendering tools.
* @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.
@@ -243,7 +243,7 @@ function _genEventArgsDoc(args: EventParameter[], devdocIfExists: DevdocOutput |
}
/**
* Extract documentation for each method paramater from @param params.
* Extract documentation for each method parameter from @param params.
*/
function _genMethodParamsDoc(
name: string,