Skip to content Skip to sidebar Skip to footer

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?

Solution 1:

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

Post a Comment for "Getting Jsdoc Output In Json Format"