jsdoc-api
jsdoc-api copied to clipboard
jsdoc2md
A programmatic interface for jsdoc3 with a few extra features
Use case: Debugging tooling that uses jsdoc-api causes > JSDOC_ERROR: Debugger attached to be thrown, even when the jsdoc command executed succesfully. This prevents debugging past any jsdoc-api usage as...
Use case: Source code of multiple files need to be prepossessed before passing them to the jsdoc-api for the doc generation. Concatenation of these codes would not always be possible....
This is the same issue as reported in https://github.com/jsdoc2md/jsdoc-api/issues/21 I'm running into this issue even after I have upgraded to 6.0.1. I'm using Node v14.15.4 on Windows 10. Not sure...
As I experimented with JSDoc API, I tried the following code: ```js const jsdoc = require('jsdoc-api') jsdoc.explainSync({files: 'functions/engine/scenarios.js', pedantic: false}); ``` Unfortunately, that throws an error, where it seems as...
I am attempting to pass file contents that I retrieved by calling the GitHub API into explainSync. When I was previously reading a local file using `fs.readFileSync().toString()` and passing this...
If the number of files in `this.inputFileSet.files` is large enough, [`readCache()`](https://github.com/jsdoc2md/jsdoc-api/blob/master/lib/jsdoc-command.js#L128) reaches the user's limit and rejects with an error. The error is swallowed in [`getOutput()`](https://github.com/jsdoc2md/jsdoc-api/blob/master/lib/explain.js#L15), which manifests in a...
**Issue** When parsing a bloc of comment containing nested `@link` in a `@see`, the `see` key in the output gives raw links instead of parsing the name of the link...
Currently, if one passes in the path to a configuration file via the `configure` option we still get this error message: `Must set either .files or .source options` If the...
