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

remove stale comments

Browse Source
This commit is contained in:
F. Eugene Aumson
2018-09-17 18:46:11 -04:00
parent d40a670d0b
commit 91de15d50e
1 changed files with 4 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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,