aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-26 03:32:52 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-26 04:31:40 +0800
commit2e7b218f4032cb213b947322e3e07ccb8709ca2b (patch)
tree88b46bba14a54ec26839a93f4f5b04c011463b4b /packages
parent7fbfd9ccd935812796ce297bb81fd8a4b72aa734 (diff)
downloaddexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar.gz
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar.bz2
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar.lz
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar.xz
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.tar.zst
dexon-sol-tools-2e7b218f4032cb213b947322e3e07ccb8709ca2b.zip
fix: comments
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
Diffstat (limited to 'packages')
-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 b0c9ff314..5ddf001a6 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -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,