diff options
| author | F. Eugene Aumson <gene@aumson.org> | 2018-09-18 05:35:11 +0800 |
|---|---|---|
| committer | F. Eugene Aumson <gene@aumson.org> | 2018-09-18 07:31:34 +0800 |
| commit | 401ef2edef50a73ec387d95ac9998f9badb4b34a (patch) | |
| tree | 49af77021006d712b22a53b66fdbfe477d1061e0 /packages/sol-doc | |
| parent | 9201273939598a13ed00084acdb384403c36fcc4 (diff) | |
| download | dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar.gz dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar.bz2 dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar.lz dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar.xz dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.tar.zst dexon-sol-tools-401ef2edef50a73ec387d95ac9998f9badb4b34a.zip | |
minorly tweak comments
Diffstat (limited to 'packages/sol-doc')
| -rw-r--r-- | packages/sol-doc/src/solidity_doc_generator.ts | 1 | ||||
| -rw-r--r-- | packages/sol-doc/test/solidity_doc_generator_test.ts | 4 |
2 files changed, 2 insertions, 3 deletions
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts index e0dcb692a..6b561d8a6 100644 --- a/packages/sol-doc/src/solidity_doc_generator.ts +++ b/packages/sol-doc/src/solidity_doc_generator.ts @@ -122,7 +122,6 @@ function _genConstructorDoc(abiDefinition: ConstructorAbi, devdocIfExists: Devdo ); const comment = _devdocMethodDetailsIfExist(methodSignature, devdocIfExists); - // TODO: figure out why devdoc'd constructors don't get output by solc const constructorDoc: SolidityMethod = { isConstructor: true, diff --git a/packages/sol-doc/test/solidity_doc_generator_test.ts b/packages/sol-doc/test/solidity_doc_generator_test.ts index 23ffe7b9e..896690ce6 100644 --- a/packages/sol-doc/test/solidity_doc_generator_test.ts +++ b/packages/sol-doc/test/solidity_doc_generator_test.ts @@ -13,7 +13,7 @@ chaiSetup.configure(); const expect = chai.expect; describe('#SolidityDocGenerator', () => { - it('should generate a doc object that matches the devdoc-free fixture', async () => { + it('should generate a doc object that matches the devdoc-free TokenTransferProxy fixture', async () => { const doc = await generateSolDocAsync(`${__dirname}/../../test/fixtures/contracts`, [ 'TokenTransferProxyNoDevdoc', ]); @@ -27,7 +27,7 @@ describe('#SolidityDocGenerator', () => { generateSolDocAsync(`${__dirname}/../../test/fixtures/contracts`, ['TokenTransferProxy']), ]; docPromises.forEach(docPromise => { - it('should generate a doc object that matches the fixture', async () => { + it('should generate a doc object that matches the TokenTransferProxy fixture', async () => { const doc = await docPromise; expect(doc).to.not.be.undefined(); |