Add test that structs are documented in separate section

2018-09-29 14:22:49 +01:00
parent 2b6a9911f5
commit b9eb2b3918
1 changed files with 7 additions and 0 deletions
--- a/packages/sol-doc/test/solidity_doc_generator_test.ts
+++ b/packages/sol-doc/test/solidity_doc_generator_test.ts
@@ -207,6 +207,13 @@ describe('#SolidityDocGenerator', () => {
        expect(methodWithStructParamAndReturn.returnComment).to.be.equal('RETURN_COMMENT');
        expect(methodWithStructParamAndReturn.parameters[0].comment).to.be.equal('STUFF_COMMENT');
    });
+    it('should document the structs included in a contract', async () => {
+        const doc = await solDoc.generateSolDocAsync(`${__dirname}/../../test/fixtures/contracts`, [
+            'StructParamAndReturn',
+        ]);
+        expect(doc.structs).to.not.be.undefined();
+        expect(doc.structs.types.length).to.be.equal(1);
+    });
 });

 function verifyTokenTransferProxyABIIsDocumented(doc: DocAgnosticFormat, contractName: string): void {