I need to automatically generate documentation for my Intern 4 functional tests. I attempted using typedoc, which worked well when parsing my object page functions. However, it failed when working with functional test suites like the one below:
/**
* This is a test comment for general purpose
*/
/**
*
*/
const { registerSuite } = intern.getInterface('object');
const { url } = intern.getPlugin('conf');
import {
tryLogin,
pollForDElement,
clickByDId,
clickSeq,
verifyGantt,
verifyIcon,
verifyCell
} from '../objectPage';
declare let ui: any;
let grid:string;
let id:string;
registerSuite('cells-pre-test',
{
/**
* this is a test comment for a test
*
*/
'login'()
{
return this.remote
.setFindTimeout(20000)
.setPageLoadTimeout(20000)
.setExecuteAsyncTimeout(20000)
.get(url)
.then(tryLogin('xxx', 'xxx'));
}
});
When running the command:
typedoc --module commonjs --target ES6 --out docs/ tests/
only the general purpose comment appears in the generated documentation, not the comments specific to the test suite.
If anyone has suggestions on how to address this issue or knows of alternative tools that can handle automatic Typescript parsing, please let me know!
Thank you