Skip to content

jsdoc

JsDocParser

The JsDocParser class provides functionality to parse files and generate markdown content based on JSDoc comments.

Kind: global class
Implements: Parser

jsDocParser.parse(file, config) ⇒ Promise.<(ParseReturn|undefined)>

Parses the provided file and returns the generated markdown content.

Kind: instance method of JsDocParser
Returns: Promise.<(ParseReturn|undefined)> - - The parsed content or undefined.

ParamTypeDescription
fileDirectoryFileThe file to be parsed.
configParserConfigThe configuration for parsing.

Released under the MIT License.