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.
Param | Type | Description |
---|---|---|
file | DirectoryFile | The file to be parsed. |
config | ParserConfig | The configuration for parsing. |