Clever Geek Handbook

Getting JSDoc output in JSON format

Is there a way to set up the JSDoc so that the output is in JSON format instead of the usual HMTL format?

+3


source to share


1 answer


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

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


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

+6


source






More articles:


All Articles