Tool to generate documentation from JSDoc on TypeScript interfaces -
i have .d.ts file interfaces describing library. has jsdoc comments, shown via intellisense in visual studio when people refer .d.ts in code:
/** description of jsnlogappender */ interface jsnlogappender { /* description of setoptions */ setoptions(options: jsnlogappenderoptions): void; /* description of log */ log(logitem: jsnlogitem): void; } ... etc ...
i need generate documentation based on jsdoc , typescript interfaces. problem generators found work javascript, , interfaces not compiled javascript. put jsdoc on actual classes , functions implement interfaces, lose intellisense when people refer .d.ts file.
is there tool generates html documentation jsdoc comments , typescript interface definitions in .d.ts file?
i found npm module claims this, though haven't tried yet: https://www.npmjs.org/package/tsdoc
Comments
Post a Comment