diff options
author | F. Eugene Aumson <gene@aumson.org> | 2018-09-18 06:46:11 +0800 |
---|---|---|
committer | F. Eugene Aumson <gene@aumson.org> | 2018-09-18 07:31:42 +0800 |
commit | 91de15d50e77db615da900ffa7aba6d32f40a28e (patch) | |
tree | d4c10286a1ef33d82d5d688a22a2cc7b8ceb74df | |
parent | d40a670d0be4db73dc15dc33094663f9c617312c (diff) | |
download | dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar.gz dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar.bz2 dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar.lz dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar.xz dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.tar.zst dexon-0x-contracts-91de15d50e77db615da900ffa7aba6d32f40a28e.zip |
remove stale comments
-rw-r--r-- | packages/sol-doc/src/solidity_doc_generator.ts | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts index 6b561d8a6..8093020b9 100644 --- a/packages/sol-doc/src/solidity_doc_generator.ts +++ b/packages/sol-doc/src/solidity_doc_generator.ts @@ -115,21 +115,17 @@ function _genDocSection(compiledContract: StandardContractOutput): DocSection { } function _genConstructorDoc(abiDefinition: ConstructorAbi, devdocIfExists: DevdocOutput | undefined): SolidityMethod { - const { parameters, methodSignature } = _genMethodParamsDoc( - '', // TODO: update depending on how constructors are keyed in devdoc - abiDefinition.inputs, - devdocIfExists, - ); + const { parameters, methodSignature } = _genMethodParamsDoc('', abiDefinition.inputs, devdocIfExists); const comment = _devdocMethodDetailsIfExist(methodSignature, devdocIfExists); const constructorDoc: SolidityMethod = { isConstructor: true, name: '', // sad we have to specify this - callPath: '', // TODO: wtf is this? + callPath: '', parameters, returnType: { name: '', typeDocType: TypeDocTypes.Intrinsic }, // sad we have to specify this - isConstant: false, // constructors are non-const by their nature, right? + isConstant: false, isPayable: abiDefinition.payable, comment, }; @@ -181,12 +177,11 @@ function _genMethodDoc( : devdocIfExists.methods[methodSignature].return; const isConstant = abiDefinition.type === 'fallback' ? true : abiDefinition.constant; - // TODO: determine whether fallback functions are always constant, as coded just above const methodDoc: SolidityMethod = { isConstructor: false, name, - callPath: '', // TODO: wtf is this? + callPath: '', parameters, returnType, returnComment, |