ts-gendoc
get info from TypeScript type declaration and generate document
const filename = "/root/myfile.ts" // absolute pathconst symbolName = "SystemOptions" // is exported interface or type const analyzer = Analyzerconst symbol = analyzerconst info = analyzerconst markdown = console
JSDoc marks
You may use @gendoc flag1, flag2
in your jsdoc comment. Supported flags:
no-children
: do not print Object's children (the nested list)hidden
: do not print this field in document
for example, in your ts file:
API
- TO BE DONE