Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Getting JSDoc output in JSON format

Is there any way to configure JSDoc such that the output is in JSON format instead of the usual HMTL format?

like image 264
Shailesh Tainwala Avatar asked Aug 08 '14 18:08

Shailesh Tainwala


1 Answers

There is an option "-X" ("explain") which creates a JSON file with parsed AST.

jsdoc -X ./mylib/ > jsdoc-ast.json

To understand this JSON you can use documented schema: https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/schema.js

like image 175
Shrike Avatar answered Sep 20 '22 00:09

Shrike



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!