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

add and test support for return comment

Browse Source
This commit is contained in:
F. Eugene Aumson
2018-09-17 17:27:33 -04:00
parent 5b07669bd0
commit 9201273939
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/sol-doc/test/solidity_doc_generator_test.ts
View File

@@ -84,6 +84,9 @@ describe('#SolidityDocGenerator', () => {
it('return type name', () => {
expect(methodDoc.returnType.name).to.equal('r');
});
it('return comment', () => {
expect(methodDoc.returnComment).to.equal('publicMethod @return');
});
});
describe('should emit external method documentation for', () => {
let methodDoc: SolidityMethod;
@@ -111,6 +114,9 @@ describe('#SolidityDocGenerator', () => {
it('return type name', () => {
expect(methodDoc.returnType.name).to.equal('r');
});
it('return comment', () => {
expect(methodDoc.returnComment).to.equal('externalMethod @return');
});
});
it('should not truncate a multi-line devdoc comment', () => {
// tslint:disable-next-line:no-unnecessary-type-assertion